-
Notifications
You must be signed in to change notification settings - Fork 2
Feat/issue template #53
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
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
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,103 @@ | ||
| --- | ||
| name: 🐛 Bug Report | ||
| description: File a bug report to help us improve | ||
| title: "[BUG] " | ||
| labels: ["bug"] | ||
| assignees: [] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thanks for taking the time to fill out this bug report! | ||
|
|
||
| - type: checkboxes | ||
| id: repository-check | ||
| attributes: | ||
| label: Repository Check | ||
| description: Please verify you're in the right repository | ||
| options: | ||
| - label: I have verified this is the correct repository for this issue | ||
| required: true | ||
| - label: This is NOT about HTTP signatures (should be in `apsig` repo) | ||
| required: true | ||
| - label: This is NOT about ActivityStreams models (should be in `apmodel` repo) | ||
| required: true | ||
|
|
||
| - type: input | ||
| id: apkit-version | ||
| attributes: | ||
| label: apkit version | ||
| description: What version of apkit are you using? | ||
| placeholder: e.g. 0.3.3 | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: input | ||
| id: python-version | ||
| attributes: | ||
| label: Python version | ||
| description: What version of Python are you using? | ||
| placeholder: e.g. 3.11.0 | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: dropdown | ||
| id: os | ||
| attributes: | ||
| label: Operating System | ||
| description: What operating system are you using? | ||
| options: | ||
| - Linux | ||
| - macOS | ||
| - Windows | ||
| - Other | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: bug-description | ||
| attributes: | ||
| label: Bug Description | ||
| description: A clear and concise description of what the bug is | ||
| placeholder: Describe the bug... | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: steps-to-reproduce | ||
| attributes: | ||
| label: Steps to Reproduce | ||
| description: Steps to reproduce the behavior | ||
| placeholder: | | ||
| 1. Go to '...' | ||
| 2. Click on '....' | ||
| 3. Scroll down to '....' | ||
| 4. See error | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: expected-behavior | ||
| attributes: | ||
| label: Expected Behavior | ||
| description: A clear and concise description of what you expected to happen | ||
| placeholder: What should happen... | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: actual-behavior | ||
| attributes: | ||
| label: Actual Behavior | ||
| description: A clear and concise description of what actually happened | ||
| placeholder: What actually happened... | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: code-sample | ||
| attributes: | ||
| label: Code Sample | ||
| description: If applicable, please provide a minimal code sample that reproduces the issue | ||
| render: python | ||
| --- |
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: false | ||
| contact_links: | ||
| - name: "Current Project Status (Important)" | ||
| url: "https://github.com/fedi-libs/apkit/discussions/51" | ||
| about: "Please read this before contributing or asking questions." | ||
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,66 @@ | ||
| --- | ||
| name: 🚀 Feature Request | ||
| description: Suggest an idea for this project | ||
| title: "[FEAT] " | ||
| labels: ["enhancement"] | ||
| assignees: [] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thanks for suggesting a new feature! | ||
|
|
||
| - type: checkboxes | ||
| id: repository-check | ||
| attributes: | ||
| label: Repository Check | ||
| description: Please verify you're in the right repository | ||
| options: | ||
| - label: I have verified this is the correct repository for this feature | ||
| required: true | ||
| - label: This is NOT about HTTP signatures (should be in `apsig` repo) | ||
| required: true | ||
| - label: This is NOT about ActivityStreams models (should be in `apmodel` repo) | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: feature-description | ||
| attributes: | ||
| label: Feature Description | ||
| description: A clear and concise description of the feature you'd like to see added | ||
| placeholder: Describe the feature... | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: motivation | ||
| attributes: | ||
| label: Motivation | ||
| description: Please explain why this feature would be useful and what problem it solves | ||
| placeholder: Why is this feature needed? | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: proposed-solution | ||
| attributes: | ||
| label: Proposed Solution | ||
| description: A clear description of what you want to happen | ||
| placeholder: How should this feature work? | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: alternatives | ||
| attributes: | ||
| label: Alternatives Considered | ||
| description: Please describe alternative solutions or features you've considered | ||
| placeholder: What other approaches have you considered? | ||
|
|
||
| - type: textarea | ||
| id: additional-context | ||
| attributes: | ||
| label: Additional Context | ||
| description: Add any other context, mockups, or examples about the feature request here | ||
| placeholder: Any additional information... | ||
| --- |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To ensure that users are encouraged to use the new issue templates, it's recommended to disable blank issues by uncommenting this line. This will guide contributors to provide structured feedback through the templates you've created, improving the quality of issue reports.