valibot icon indicating copy to clipboard operation
valibot copied to clipboard

feat: added PR and Issue template

Open dev-phantom opened this issue 1 year ago • 10 comments

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:

  1. 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.
  2. 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.

dev-phantom avatar Aug 13 '23 23:08 dev-phantom

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...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify[bot] avatar Aug 13 '23 23:08 netlify[bot]

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.

fabian-hiller avatar Aug 14 '23 10:08 fabian-hiller

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 🚀

dev-phantom avatar Aug 14 '23 13:08 dev-phantom

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 ?

LBF38 avatar Aug 25 '23 23:08 LBF38

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 🚀

dev-phantom avatar Aug 25 '23 23:08 dev-phantom

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.

fabian-hiller avatar Sep 14 '23 21:09 fabian-hiller

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

dev-phantom avatar Sep 15 '23 00:09 dev-phantom

Sorry for not coming back to this, but other things had a higher priority. I will probably review it when it becomes more important.

fabian-hiller avatar Jul 30 '24 19:07 fabian-hiller

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?

dev-phantom avatar Aug 14 '24 14:08 dev-phantom

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.

fabian-hiller avatar Aug 15 '24 11:08 fabian-hiller