-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added Templates for P.R., Issues and bug reports (#43)
* Added .github folder with templates for feature request and bug report * Added template for pull requests * Re-arranged .github template files
- Loading branch information
1 parent
9f0e105
commit a790df1
Showing
3 changed files
with
96 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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,43 @@ | ||
--- | ||
name: Bug report | ||
about: Report a bug | ||
labels: bug | ||
--- | ||
|
||
## Environment 🖥️ | ||
* OS Version: | ||
|
||
* Python Version: | ||
|
||
* Do you have a dedicated GPU ? | ||
|
||
* NVIDIA Driver Version (if applicable): | ||
|
||
* CUDA Version (if applicable): | ||
|
||
* Are you running this project natively or using Docker ? | ||
|
||
* Is the issue present in the main branch or any of the development branch ? | ||
|
||
<details> | ||
|
||
``` | ||
# paste log here | ||
``` | ||
|
||
</details> | ||
|
||
## Description 📖 | ||
* Expected behavior: <!-- Tell us what you expected to happen --> | ||
* Actual behavior: <!-- What happened instead --> | ||
|
||
## Steps to reproduce 👀 | ||
<!-- Provide steps so we can try to reproduce this issue --> | ||
|
||
1. | ||
2. | ||
3. | ||
|
||
## Output 💥 | ||
<!-- Provide screenshots, console logs, backtraces, and/or anything that could | ||
be useful to us resolving this issue --> |
This file contains 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: Request a new feature | ||
labels: enhancement | ||
--- | ||
|
||
## Desired behavior | ||
<!-- Describe the current problem and the feature you want implemented.--> | ||
|
||
## Alternatives considered | ||
<!-- Describe alternate solutions or features you've considered.--> | ||
|
||
## Implementation suggestion | ||
<!-- Provide a suggestion on how to implement this feature, which could help us | ||
expedite this implementation.--> | ||
|
||
## Examples of this feature in some other project (if applicable) | ||
<!-- Provide an example of a similar/same feature present in some other project | ||
if you found any. --> | ||
|
||
## Additional context | ||
<!-- Provide any other additional context (e.g., screenshots) about your feature | ||
request.--> |
This file contains 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,30 @@ | ||
# Description 📖 | ||
|
||
Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change. | ||
|
||
Fixes # (issue) | ||
|
||
## Type of change 📜 | ||
|
||
Please delete options that are not relevant. | ||
|
||
- [ ] Bug fix (non-breaking change which fixes an issue) | ||
- [ ] New feature (non-breaking change which adds functionality) | ||
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) | ||
- [ ] This change requires a documentation update | ||
- [ ] This change requires testing before it can be merged into the main/development branch | ||
|
||
# How Has This Been Tested? 👀 | ||
|
||
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration | ||
|
||
- [ ] Test A | ||
- [ ] Test B | ||
|
||
**Test Configuration** 🖥️ | ||
* OS version: | ||
* Hardware: | ||
* NVIDIA Driver: | ||
* CUDA Version: | ||
|
||
|