-
Notifications
You must be signed in to change notification settings - Fork 13
feat(template): add GitHub PR template and issue templates #36
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
2 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,35 @@ | ||
| --- | ||
| name: Bug Report | ||
| about: Create a report to help us improve | ||
| title: '[Bug]:' | ||
| labels: 'bug' | ||
| assignees: '' | ||
|
|
||
| --- | ||
|
|
||
| **<u>OpenJudge is an open-source project. To involve a broader community, we recommend asking your questions in English.</u>** | ||
|
|
||
| **Describe the bug** | ||
| A clear and concise description of what the bug is. | ||
|
|
||
| **To Reproduce** | ||
| Steps to reproduce the behavior: | ||
|
|
||
| 1. Code snippet that causes the bug: | ||
| 2. Steps to execute the code: | ||
| 3. Error message or unexpected behavior observed: | ||
|
|
||
| **Expected behavior** | ||
| A clear and concise description of what you expected to happen. | ||
|
|
||
| **Error messages** | ||
| Detailed error messages. | ||
|
|
||
| **Environment (please complete the following information):** | ||
|
|
||
| - OpenJudge Version: [e.g. 1.0.0 via `print(openjudge.__version__)`] | ||
| - Python Version: [e.g. 3.10] | ||
| - OS: [e.g. macos, windows] | ||
|
|
||
| **Additional context** | ||
| Add any other context about the problem here. | ||
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,12 @@ | ||
| --- | ||
| name: Custom issue template | ||
| about: Describe this issue template's purpose here. | ||
| title: '' | ||
| labels: '' | ||
ployts marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| assignees: '' | ||
|
|
||
| --- | ||
|
|
||
| **<u>OpenJudge is an open-source project. To involve a broader community, we recommend asking your questions in English.</u>** | ||
|
|
||
| **Please describe your issue or question in detail below:** | ||
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,23 @@ | ||
| --- | ||
| name: Feature Request | ||
| about: Suggest an idea for this project | ||
| title: '[Feature]: ' | ||
| labels: 'enhancement' | ||
| assignees: '' | ||
|
|
||
| --- | ||
|
|
||
| **<u>OpenJudge is an open-source project. To involve a broader community, we recommend asking your questions in English.</u>** | ||
|
|
||
|
|
||
| **Is your feature request related to a problem? Please describe.** | ||
| A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
|
||
| **Describe the solution you'd like** | ||
| A clear and concise description of what you want to happen. | ||
|
|
||
| **Describe alternatives you've considered** | ||
| A clear and concise description of any alternative solutions or features you've considered. | ||
|
|
||
| **Additional context** | ||
| Add any other context or screenshots about the feature request here. |
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,17 @@ | ||
| ## OpenJudge Version | ||
|
|
||
| [The version of OpenJudge you are working on, e.g. `import openjudge; print(openjudge.__version__)`] | ||
|
|
||
| ## Description | ||
|
|
||
| [Please describe the background, purpose, changes made, and how to test this PR] | ||
|
|
||
| ## Checklist | ||
|
|
||
| Please check the following items before code is ready to be reviewed. | ||
|
|
||
| - [ ] Code has been formatted with `pre-commit run --all-files` command | ||
ployts marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - [ ] All tests are passing | ||
| - [ ] Docstrings are in Google style | ||
| - [ ] Related documentation has been updated (e.g. links, examples, etc.) | ||
| - [ ] Code is ready for review | ||
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.