-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Issue & PR Template] Add Issue Template & PR Template & Contribution…
… Guide (dmlc#192) * add issue template * add contribution guide and PR Template, adapted from mxnet * fix typo
- Loading branch information
1 parent
063ed69
commit 82c4df4
Showing
6 changed files
with
129 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,39 @@ | ||
--- | ||
name: "\U0001F41B Bug Report" | ||
about: Submit a bug report to help us improve DGL | ||
|
||
--- | ||
|
||
## 🐛 Bug | ||
|
||
<!-- A clear and concise description of what the bug is. --> | ||
|
||
## To Reproduce | ||
|
||
Steps to reproduce the behavior: | ||
|
||
1. | ||
1. | ||
1. | ||
|
||
<!-- If you have a code sample, error messages, stack traces, please provide it here as well --> | ||
|
||
## Expected behavior | ||
|
||
<!-- A clear and concise description of what you expected to happen. --> | ||
|
||
## Environment | ||
|
||
- DGL Version (e.g., 1.0): | ||
- Backend Library & Version (e.g., PyTorch 0.4.1): | ||
- OS (e.g., Linux): | ||
- How you installed DGL (`conda`, `pip`, source): | ||
- Build command you used (if compiling from source): | ||
- Python version: | ||
- CUDA/cuDNN version: | ||
- GPU models and configuration: | ||
- Any other relevant information: | ||
|
||
## Additional context | ||
|
||
<!-- Add any other context about the problem here. --> |
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,10 @@ | ||
--- | ||
name: "\U0001F4DA Documentation" | ||
about: Report an issue related to docs.dgl.ai | ||
|
||
--- | ||
|
||
## 📚 Documentation | ||
|
||
<!-- Please specify whether it's tutorial part or API reference part--> | ||
<!-- A clear and concise description of what content in docs.dgl.ai is an 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,24 @@ | ||
--- | ||
name: "\U0001F680Feature Request" | ||
about: Submit a proposal/request for a new DGL feature | ||
|
||
--- | ||
|
||
## 🚀 Feature | ||
<!-- A clear and concise description of the feature proposal --> | ||
|
||
## Motivation | ||
|
||
<!-- Please outline the motivation for the proposal. Is your feature request related to a problem? e.g., I'm always frustrated when [...]. If this is related to another GitHub issue, please link here too --> | ||
|
||
## Alternatives | ||
|
||
<!-- A clear and concise description of any alternative solutions or features you've considered, if any. --> | ||
|
||
## Pitch | ||
|
||
<!-- A clear and concise description of what you want to happen. --> | ||
|
||
## Additional context | ||
|
||
<!-- Add any other context or screenshots about the feature request here. --> |
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,13 @@ | ||
--- | ||
name: "❓Questions/Help/Support" | ||
about: Do you need support? We have resources. | ||
|
||
--- | ||
|
||
## ❓ Questions and Help | ||
|
||
### Please note that this issue tracker is not a help forum and this issue will be closed. | ||
|
||
Our primary means of support is our discussion forum: | ||
|
||
- [Discussion Forum](http://discuss.dgl.ai/) |
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,28 @@ | ||
IMPORTANT: Please do not create a Pull Request without creating an issue first. | ||
|
||
Any change needs to be discussed before proceeding. Failure to do so may result in the rejection of the pull request. | ||
|
||
Please provide enough information so that others can review your pull request: | ||
|
||
## Description | ||
Explain the details for making this change. What existing problem does the pull request solve? | ||
|
||
## Test Plan | ||
Describe the test plan (required) | ||
|
||
## Checklist | ||
### Essentials | ||
Please feel free to remove inapplicable items for your PR. | ||
- [ ] The PR title starts with [$CATEGORY] (such as [Model], [Doc], [Feature]]) | ||
- [ ] Changes are complete (i.e. I finished coding on this PR) | ||
- [ ] All changes have test coverage | ||
- [ ] Code is well-documented | ||
- [ ] To the my best knowledge, examples are either not affected by this change, or have been fixed to be compatible with this change | ||
- [ ] Related issue is referred in this PR | ||
|
||
### Changes ### | ||
- [ ] Feature1, tests, (and when applicable, API doc) | ||
- [ ] Feature2, tests, (and when applicable, API doc) | ||
|
||
## Comments ## | ||
Add any other context about the pull request here. |
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,15 @@ | ||
## Contributing to DGL | ||
|
||
If you are interested in contributing to DGL, your contributions will fall | ||
into two categories: | ||
1. You want to propose a new Feature and implement it | ||
- post about your intended feature, and we shall discuss the design and | ||
implementation. Once we agree that the plan looks good, go ahead and implement it. | ||
2. You want to implement a feature or bug-fix for an outstanding issue | ||
- Look at the outstanding issues | ||
- Especially look at the Low Priority and Medium Priority issues | ||
- Pick an issue and comment on the task that you want to work on this feature | ||
- If you need more context on a particular issue, please ask and we shall provide. | ||
|
||
Once you finish implementing a feature or bugfix, please send a Pull Request. | ||
|