diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 000000000..b12e5c33f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,28 @@ +name: "\U0001F41E Bug report" +description: Create a report to help us improve Npmx +body: + - type: markdown + attributes: + value: | + Please carefully read the contribution docs before creating a bug report + 👉 https://github.com/npmx-dev/npmx.dev/blob/main/CONTRIBUTING.md + - type: textarea + id: bug-description + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is. If you intend to submit a PR for this issue, tell us in the description. Thanks! + placeholder: Bug description + validations: + required: true + - type: textarea + id: additional + attributes: + label: Additional context + description: If applicable, add any other context about the problem here + - type: textarea + id: logs + attributes: + label: Logs + description: | + Optional if you have reproduction steps. Please try not to insert an image but copy paste the log text. + render: shell-script diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..4c1540c6e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: true +contact_links: + - name: 📚 Npmx Documentation + url: https://docs.npmx.dev/ + about: Check the documentation for usage of Npmx diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 000000000..216f75757 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,36 @@ +name: '🚀 Feature request' +description: Suggest a feature that will improve Npmx +labels: ['pending triage'] +body: + - type: markdown + attributes: + value: | + Thank you for taking the time to fill out this feature request! + + Please carefully read the contribution docs before suggesting a new feature + 👉 https://github.com/npmx-dev/npmx.dev/blob/main/CONTRIBUTING.md + - type: textarea + id: feature-description + attributes: + label: Describe the feature + description: A clear and concise description of what you think would be a helpful addition to Npmx, including the possible use cases and alternatives you have considered. If you have a working prototype or module that implements it, please include a link. + placeholder: Feature description + validations: + required: true + - type: checkboxes + id: additional-info + attributes: + label: Additional information + description: Additional information that helps us decide how to proceed. + options: + - label: Would you be willing to help implement this feature? + - type: checkboxes + id: required-info + attributes: + label: Final checks + description: Before submitting, please make sure you do the following + options: + - label: Read the [contribution guide](https://github.com/npmx-dev/npmx.dev/blob/main/CONTRIBUTING.md). + required: true + - label: Check existing [issues](https://github.com/npmx-dev/npmx.dev/issues). + required: true diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..221f31ed7 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,28 @@ +### 🔗 Linked issue + + + +### 🧭 Context + + + + + +### 📚 Description + + + + + +