valibot
valibot copied to clipboard
feat: added PR and Issue template
Pull Request: Adding Pull Request and Issue Templates
Description:
This pull request adds pull request and issue templates to the repository in order to enhance the consistency and quality of contributions and discussions. The templates provide a standardized structure for creating pull requests and raising issues, making it easier for both contributors and maintainers to understand and address the changes or problems.
Changes Made:
-
Added a Pull Request Template (
PULL_REQUEST_TEMPLATE.md
):- Outlines the purpose of the pull request.
- Provides a checklist for the contributor to ensure all necessary steps are completed.
- Encourages the inclusion of relevant context, changes made, and any related issues.
-
Added an Issue Template (
ISSUE_TEMPLATE
):- Offers options for different types of issues, such as bug reports or feature requests.
- Asks for a clear description of the issue, steps to reproduce (if applicable), and expected behavior.
- Includes sections for environment details, additional context, and related issues (if any).
Benefits:
- Improves communication between contributors and maintainers.
- Reduces the back-and-forth clarifications required for pull requests and issues.
- Ensures that important details are not overlooked during the submission of contributions or issues.
- Enhances the overall quality of contributions by providing clear guidelines.
related documents
Fixes #95
N/A
Please review and merge this pull request at your earliest convenience. Your feedback and suggestions for improvement are highly appreciated.
Deploy Preview for valibot ready!
Name | Link |
---|---|
Latest commit | 4ad92409e44f0df79dfe20f6688eeada4f0fbd24 |
Latest deploy log | https://app.netlify.com/sites/valibot/deploys/650350539f5a9600083f84eb |
Deploy Preview | https://deploy-preview-101--valibot.netlify.app |
Preview on mobile | Toggle QR Code...Use your smartphone camera to open QR code link. |
To edit notification comments on pull requests, go to your Netlify site configuration.
Thank you very much! The next few days I have to focus on my bachelor thesis. As soon as I find time, I'll get back to you.
Thank you very much! The next few days I have to focus on my bachelor thesis. As soon as I find time, I'll get back to you.
Anticipating 🚀
Hi, here is a quick suggestion before merging the PR: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
There are issue forms syntax now in GitHub. I found it easier to fill than markdown templates. What do you think ?
Hi, here is a quick suggestion before merging the PR: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
There are issue forms syntax now in GitHub. I found it easier to fill than markdown templates. What do you think ?
Thanks for pointing it out I'll fix that immediately 🚀
Thanks again for working on the templates. Currently I am focusing on bugs and important enhancements. I will probably check this PR in 2 to 3 weeks and give you feedback.
Thanks again for working on the templates. Currently I am focusing on bugs and important enhancements. I will probably check this PR in 2 to 3 weeks and give you feedback.
anticipating
Sorry for not coming back to this, but other things had a higher priority. I will probably review it when it becomes more important.
Sorry for not coming back to this, but other things had a higher priority. I will probably review it when it becomes more important. okay thanks for reaching out
should i close this?
No, we can leave it open. Right now it works great without a template, but once v1 is available and Valibot becomes more popular I might change my mind.