-
-
Notifications
You must be signed in to change notification settings - Fork 261
chore: add issue templates for bug reports and pull + feature requests #1531
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.
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
Open
colinscz
wants to merge
6
commits into
npmx-dev:main
Choose a base branch
from
colinscz:chore/add-issue-templates
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+97
−0
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
8bead3d
chore: create pull request template for contributions
colinscz a81b57e
chore: create feature request issue template
colinscz da780c9
chore: revise bug report template for Npmx
colinscz 678c47c
chore: add issue template configuration for Npmx
colinscz 1b5e085
chore: Enhance PR template with context and tradeoffs section
colinscz b1080f6
chore: address review comments
colinscz File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 | ||
colinscz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 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 | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| ### 🔗 Linked issue | ||
|
|
||
| <!-- Please ensure there is an open issue and mention its number. For example, "resolves #123" --> | ||
|
|
||
| ### 🧭 Context | ||
|
|
||
| <!-- Brief background and why this change is needed --> | ||
|
|
||
| <!-- High-level summary of what changed --> | ||
|
|
||
| ### 📚 Description | ||
|
|
||
| <!-- Describe your changes in detail. Why is this change required? What problem does it solve? --> | ||
|
|
||
| <!-- If you used AI tools to help with this contribution, please ensure the PR description and code reflect your own understanding. | ||
| Write in your own voice rather than copying AI-generated text. --> | ||
|
|
||
| <!---------------------------------------------------------------------- | ||
| Before creating the pull request, please make sure you do the following: | ||
|
|
||
| - Check that there isn't already a PR that solves the problem the same way. If you find a duplicate, please help us reviewing it. | ||
| - Ensure that PR title follows conventional commits (https://www.conventionalcommits.org) | ||
| - Update the corresponding documentation if needed. | ||
| - Include relevant tests that fail without this PR but pass with it. | ||
| - Add any additional context, tradeoffs, follow-ups, or things reviewers should be aware of. | ||
|
|
||
| Thank you for contributing to Npmx! | ||
colinscz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| -----------------------------------------------------------------------> | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.