-
Notifications
You must be signed in to change notification settings - Fork 0
config(github): add issue and pr templates #13
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
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,21 @@ | ||
| name: 🚀 Feature Request | ||
| description: Suggest an idea, feature, or enhancement | ||
| labels: [enhancement] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thank you for submitting an idea. It helps make github-code-search better. | ||
| - type: textarea | ||
| attributes: | ||
| label: What is the problem this feature would solve? | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: What is the feature you are proposing to solve the problem? | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: What alternatives have you considered? |
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,38 @@ | ||
| name: 🐛 Bug Report | ||
| description: Report an issue that should be fixed | ||
| labels: | ||
| - bug | ||
| - needs triage | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thank you for submitting a bug report. It helps make github-code-search better. | ||
|
|
||
| Make sure you are running the [latest](https://github.com/fulll/github-code-search?tab=readme-ov-file#installation) version of github-code-search. | ||
| The bug you are experiencing may already have been fixed. | ||
|
|
||
| Please try to include as much information as possible. | ||
|
|
||
| - type: input | ||
| attributes: | ||
| label: What version of github-code-search is running? | ||
| description: Copy the output of `github-code-search --version` | ||
| - type: textarea | ||
| attributes: | ||
| label: What steps can reproduce the bug? | ||
| description: Explain the bug and provide a code snippet that can reproduce it. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: What is the expected behavior? | ||
| description: If possible, please provide text instead of a screenshot. | ||
| - type: textarea | ||
| attributes: | ||
| label: What do you see instead? | ||
| description: If possible, please provide text instead of a screenshot. | ||
| - type: textarea | ||
| attributes: | ||
| label: Additional information | ||
| description: Is there anything else you think we should know? | ||
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 @@ | ||
| blank_issues_enabled: 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,3 @@ | ||
| ### What does this PR do? | ||
|
|
||
| ### How did you verify your code works? |
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.
The description asks users to "provide a code snippet that can reproduce it", but since github-code-search is a CLI tool rather than a library, this phrasing might be confusing. Consider changing this to "provide the exact command and steps that reproduce the bug" to better align with the CLI nature of the tool and match the guidance in CONTRIBUTING.md (lines 99-100) which asks for "The exact command you ran".