diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 000000000..f1a247f6d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,60 @@ +name: 🐞 Bug +description: File a bug/issue +title: "[BUG] " +labels: ["Bug", "Needs Triage"] +assignees: fabian-hiller +body: +- type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the bug you encountered. + options: + - label: I have searched the existing issues + required: true +- type: textarea + attributes: + label: Current Behavior + description: A concise description of what you're experiencing. + validations: + required: false +- type: textarea + attributes: + label: Expected Behavior + description: A concise description of what you expected to happen. + validations: + required: false +- type: textarea + attributes: + label: Steps To Reproduce + description: Steps to reproduce the behavior. + placeholder: | + 1. Go to ... + 1. click on... + 1. scroll down... + 1. See error... + validations: + required: false +- type: textarea + attributes: + label: Environment + description: | + examples: + - **OS**: Ubuntu 20.04 + - **Node**: 13.14.0 + - **npm**: 7.6.3 + value: | + - OS: + - Node: + - npm: + render: markdown + validations: + required: false +- type: textarea + attributes: + label: Anything else? + description: | + Links? References? Anything that will give us more context about the issue you are encountering! + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md new file mode 100644 index 000000000..8ffa2e298 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -0,0 +1,38 @@ +name: 🚀 Feature Request +about: Suggest an idea or enhancement for Valibot +title: "[Feature Request]: " +labels: enhancement +assignees: fabian-hiller +body: +- type: textarea + attributes: + label: Description + description: Please provide a detailed description of the feature you are requesting. Explain how it would benefit Valibot and its users. + validations: + required: false +- type: textarea + attributes: + label: Implementation Details (Optional) + description: If you have any suggestions on how this feature could be implemented, provide details here. Code snippets or diagrams can be helpful. + validations: + required: false +- type: textarea + attributes: + label: Steps To Reproduce + description: Steps to reproduce the behavior. + placeholder: | + 1. In this environment... + 1. With this config... + 1. Run '...' + 1. See error... + validations: + required: false +- type: textarea + attributes: + label: Anything else? + description: | + Links? References? Anything that will give us more context about the issue you are encountering! + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: false diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..f64801006 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,50 @@ +--- +name: 🚀 Pull Request +about: Submit changes to Valibot +title: "[PR]: " +labels: enhancement +assignees: [fabian-hiller] +--- + +## 🚀 Pull Request + +### Description + +<!-- Please provide a brief description of the changes you've made and why. --> + +### Related Issue + +<!-- If this pull request is related to an issue, please reference it here (e.g., "Closes #123"). --> + +### Changes Made + +<!-- List the changes you've made in this pull request. + +- Change 1 +- Change 2 +- ... --> + +### Screenshots/screenrecord (if applicable) + +<!-- If your changes include visual updates, add relevant screenshots. --> + +### Checklist + +- [ ] I have tested the changes locally. +- [ ] I have updated the documentation as needed. +- [ ] My code follows the project's coding style and conventions. +- [ ] I have added or updated relevant tests. + +### Additional Context + +<!-- Add any additional context or information about the pull request. --> + +--- + +## 🗨️ Discussion + +<!-- Feel free to discuss this pull request with the community in the comments section below. --> + +<!-- +Please follow the pull request template as closely as possible for effective review and merging. +-->