Skip to content
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

Add issue & PR template #133

Merged
merged 1 commit into from
Dec 31, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
name: "\U0001F41B Bug Report"
about: Submit a bug report to help us improve CogDL

---

## 🐛 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

- CogDL version:
- OS (e.g., Linux):
- Python version:
- PyTorch version:
- PyG version (if installed):
- DGL version (if installed):
- CUDA/cuDNN version (if applicable):
- Any other relevant information:

## Additional context

<!-- Add any other context about the problem here. -->
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
name: "\U0001F4DA Documentation"
about: Report an issue related to cogdl.readthedocs.io

---

## 📚 Documentation

<!-- Please specify whether it's tutorial part or API reference part-->
<!-- Describe the issue.-->
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
name: "\U0001F680 Feature Request"
about: Submit a proposal/request for a new CogDL feature
---

## 🚀 Feature

<!-- A clear and concise description of the feature proposal. Please provide a link to the paper and code in case they exist. -->

## 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. -->

## Additional context

<!-- Add any other context or screenshots about the feature request here. -->
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: "\U0001F4DA Installation"
about: Report an installation problem with CogDL
---

## 📚 Installation

<!-- A clear and concise description of the installation error. If you have installation log file, please provide it here as well. -->

## Environment

* OS:
* Python version:
* PyTorch version:
* CUDA/cuDNN version:
* How did you try to install CogDL (wheel, source):
* Any other relevant information:

## Checklist

- [ ] I followed the [installation guide](https://github.com/thudm/cogdl#requirements-and-installation).
- [ ] I set up CUDA correctly.
- [ ] I do have multiple CUDA versions on my machine.

## Additional context

<!-- Add any other context about the problem here. -->
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/question-help.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
name: "❓Questions & Help"
about: Start a general discussion related to CogDL
---

## ❓ Questions & Help

<!-- A clear and concise description of the question. -->
12 changes: 12 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
## Description
<!-- Brief description. Refer to the related issues if existed.-->

## Checklist
Please feel free to remove inapplicable items for your PR.
- [ ] The PR title starts with [$CATEGORY] (such as [Model], [Doc], [Feature], [Bugfix])
- [ ] Changes are complete (i.e. I finished coding on this PR)
- [ ] All changes have test coverage
- [ ] Code is well-documented
- [ ] To 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