From 64762b4dd781009d1f57063efdf2a1e76ebe22b7 Mon Sep 17 00:00:00 2001 From: dev-phantom Date: Mon, 14 Aug 2023 00:20:51 +0100 Subject: [PATCH 1/2] feat: added PR and Issue template --- .github/ISSUE_TEMPLATE/bug-report.md | 54 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature-request.md | 32 ++++++++++++++ .github/pull_request_template.md | 50 +++++++++++++++++++++ 3 files changed, 136 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.md create mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 000000000..91feaa7ec --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,54 @@ +--- +name: 🐛 Bug Report +about: Report a problem or bug in Valibot +title: "[Bug]: " +labels: bug +assignees: +--- + +## 🐛 Bug Report + +### Description + + + +### Expected Behavior + + + +### Current Behavior + + + +### Steps to Reproduce + + + +### Screenshots + + + +### Environment + +- Valibot Version: [e.g., v1.0.0] +- Operating System: [e.g., Windows 10, macOS Big Sur, Ubuntu 20.04] +- Python Version: [e.g., 3.8.5] + +### Additional Information + + + +--- + +## 🗨️ Discussion + + + + diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md new file mode 100644 index 000000000..348258b6d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -0,0 +1,32 @@ +--- +name: 🚀 Feature Request +about: Suggest an idea or enhancement for Valibot +title: "[Feature Request]: " +labels: enhancement +assignees: +--- + +## 🚀 Feature Request + +### Description + + + +### Implementation Details (Optional) + + + +### Additional Context + + + +--- + +## 🗨️ Discussion + + + + 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 + + + +### Related Issue + + + +### Changes Made + + + +### Screenshots/screenrecord (if applicable) + + + +### 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 + + + +--- + +## 🗨️ Discussion + + + + From 4ad92409e44f0df79dfe20f6688eeada4f0fbd24 Mon Sep 17 00:00:00 2001 From: dev-phantom Date: Thu, 14 Sep 2023 19:26:09 +0100 Subject: [PATCH 2/2] upgraded the issue template --- .github/ISSUE_TEMPLATE/bug-report.md | 114 ++++++++++++---------- .github/ISSUE_TEMPLATE/feature-request.md | 62 ++++++------ 2 files changed, 94 insertions(+), 82 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index 91feaa7ec..f1a247f6d 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -1,54 +1,60 @@ ---- -name: 🐛 Bug Report -about: Report a problem or bug in Valibot -title: "[Bug]: " -labels: bug -assignees: ---- - -## 🐛 Bug Report - -### Description - - - -### Expected Behavior - - - -### Current Behavior - - - -### Steps to Reproduce - - - -### Screenshots - - - -### Environment - -- Valibot Version: [e.g., v1.0.0] -- Operating System: [e.g., Windows 10, macOS Big Sur, Ubuntu 20.04] -- Python Version: [e.g., 3.8.5] - -### Additional Information - - - ---- - -## 🗨️ Discussion - - - - +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 index 348258b6d..8ffa2e298 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -1,32 +1,38 @@ ---- name: 🚀 Feature Request about: Suggest an idea or enhancement for Valibot title: "[Feature Request]: " labels: enhancement -assignees: ---- - -## 🚀 Feature Request - -### Description - -<!-- Please provide a detailed description of the feature you are requesting. Explain how it would benefit Valibot and its users. --> - -### Implementation Details (Optional) - -<!-- If you have any suggestions on how this feature could be implemented, provide details here. Code snippets or diagrams can be helpful. --> - -### Additional Context - -<!-- Add any additional context or information about the feature request. --> - ---- - -## 🗨️ Discussion - -<!-- Feel free to discuss the feature request with the community in the comments section below. --> - -<!-- -Remember to search existing feature requests before creating a new one to avoid duplicates. -Please follow the feature request template as closely as possible for effective tracking and consideration. ---> +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