Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: added PR and Issue template #101

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat: added PR and Issue template #101

wants to merge 2 commits into from

Conversation

dev-phantom
Copy link

@dev-phantom dev-phantom commented Aug 13, 2023 •
edited
Loading

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.

@netlify
Copy link

netlify bot commented Aug 13, 2023 •
edited
Loading

✅ Deploy Preview for valibot ready!

Name Link
🔨 Latest commit 4ad9240
🔍 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.

@fabian-hiller fabian-hiller self-assigned this Aug 14, 2023
@fabian-hiller fabian-hiller added enhancement New feature or request github GitHub related changes labels Aug 14, 2023
@fabian-hiller
Copy link
Owner

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.

@dev-phantom
Copy link
Author

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 🚀

@LBF38
Copy link

LBF38 commented Aug 25, 2023

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 ?

@dev-phantom
Copy link
Author

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 🚀

@fabian-hiller
Copy link
Owner

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.

@dev-phantom
Copy link
Author

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

@fabian-hiller fabian-hiller force-pushed the main branch 7 times, most recently from b997a0f to 6d0cde4 Compare March 1, 2024 08:22
@fabian-hiller
Copy link
Owner

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

@dev-phantom
Copy link
Author

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?

@fabian-hiller
Copy link
Owner

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 fabian-hiller force-pushed the main branch 3 times, most recently from 17b9a03 to 4666cf9 Compare September 1, 2024 18:37
@fabian-hiller fabian-hiller force-pushed the main branch 2 times, most recently from 41ae798 to 4a7ee57 Compare September 1, 2024 21:07
@fabian-hiller fabian-hiller force-pushed the main branch 2 times, most recently from 7a97dd0 to b5f7f4d Compare October 3, 2024 17:45
@fabian-hiller fabian-hiller force-pushed the main branch 2 times, most recently from f41426c to d713dfe Compare January 4, 2025 00:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@fabian-hiller fabian-hiller

Labels
enhancement New feature or request github GitHub related changes
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[feat]: Request for PR and Issue Templates
3 participants
@dev-phantom @fabian-hiller @LBF38