Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add issue & pull request templates (#1163)
- Loading branch information
1 parent
c52a6ca
commit a84c6c6
Showing
4 changed files
with
170 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,48 @@ | ||
--- | ||
name: Bug report | ||
about: Report a bug in ARTIQ | ||
|
||
--- | ||
|
||
<!-- Above are non-Markdown tags for Github auto-prompting issue type. Template based on pylint: https://raw.githubusercontent.com/PyCQA/pylint/master/.github/ISSUE_TEMPLATE/ --> | ||
|
||
# Bug Report | ||
|
||
<!-- Thanks for reporting a bug report to ARTIQ! You can also discuss issues and ask questions on IRC (the [#m-labs channel on freenode](https://webchat.freenode.net/?channels=m-labs) or on the [ARTIQ mailing list](https://ssl.serverraum.org/lists/listinfo/artiq). Please check Github/those forums to avoid posting a repeat issue. | ||
Context helps us fix issues faster, so please include the following: | ||
--> | ||
|
||
## One-Line Summary | ||
|
||
Short summary. | ||
|
||
## Issue Details | ||
|
||
### Steps to Reproduce | ||
|
||
1. Step 1. | ||
2. Step 2. | ||
3. Step 3. | ||
|
||
### Expected Behavior | ||
|
||
Behavior | ||
|
||
### Actual (undesired) Behavior | ||
|
||
* Text description | ||
* Log message, tracebacks, screen shots where relevant | ||
|
||
### Your System | ||
|
||
* Operating System: | ||
* Conda version: | ||
* ARTIQ version: (package or git commit id, versions for bitstream, bootloader, runtime and host software). Run `conda list` | ||
* Hardware involved: | ||
|
||
<!-- | ||
For in-depth information on bug reporting, see: | ||
http://www.chiark.greenend.org.uk/~sgtatham/bugs.html https://developer.mozilla.org/en-US/docs/Mozilla/QA/Bug_writing_guidelines | ||
--> |
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 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for ARTIQ | ||
|
||
--- | ||
|
||
<!-- | ||
Hi there! Thank you for wanting to make ARTIQ better. | ||
Before you submit this, make sure that this feature wasn't | ||
already requested or if it is not already implemented in the master branch. | ||
Based on pylint: https://raw.githubusercontent.com/PyCQA/pylint/master/.github/ISSUE_TEMPLATE/2_Feature_request.md | ||
--> | ||
|
||
# ARTIQ Feature Request | ||
|
||
## Problem this request addresses | ||
|
||
A clear and concise description of what the problem is. | ||
|
||
## Describe the solution you'd like | ||
|
||
A clear and concise description of what you want to happen. | ||
|
||
## Additional context | ||
|
||
Add any other context 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,25 @@ | ||
--- | ||
name: Support question | ||
about: Questions about ARTIQ that are not covered in the documentation (Latest: https://m-labs.hk/artiq/manual-master/ or Stable: https://m-labs.hk/artiq/manual/) | ||
|
||
--- | ||
|
||
# Question | ||
|
||
<!-- | ||
Make sure you check the ARTIQ documentation before posting a question. | ||
Don't forget you can search it! | ||
Latest docs: https://m-labs.hk/artiq/manual-master/ | ||
Stable branch docs: https://m-labs.hk/artiq/manual/ | ||
Can also ask on IRC: https://webchat.freenode.net/?channels=m-labs or | ||
check mailing list archives: https://ssl.serverraum.org/lists-archive/artiq/ | ||
--> | ||
|
||
## Category: FILL_IN | ||
|
||
<!-- One-word category this question falls into: GUI, installation/setup, devices, development, documentation, etc. --> | ||
|
||
## Description | ||
|
||
Question text |
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,69 @@ | ||
<!-- | ||
Thank you for submitting a PR to ARTIQ! | ||
To ease the process of reviewing your PR, do make sure to complete the following boxes. | ||
You can also read more about contributing to ARTIQ in this document: | ||
https://github.com/m-labs/artiq/blob/master/CONTRIBUTING.rst#contributing-code | ||
Based on https://raw.githubusercontent.com/PyCQA/pylint/master/.github/PULL_REQUEST_TEMPLATE.md | ||
--> | ||
|
||
# ARTIQ Pull Request | ||
|
||
## Steps (Choose relevant, delete irrelevant before submitting) | ||
|
||
### All Pull Requests | ||
|
||
- [x] Use correct spelling and grammar. | ||
- [ ] Update [RELEASE_NOTES.md](../RELEASE_NOTES.md) if there are noteworthy changes, especially if there are changes to existing APIs. | ||
- [ ] Close/update issues. | ||
- [ ] Check the copyright situation of your changes and sign off your patches (`git commit --signoff`, see [copyright](../CONTRIBUTING.rst#copyright-and-sign-off)). | ||
|
||
### Code Changes | ||
|
||
- [ ] Run `flake8` to check code style (follow PEP-8 style). `flake8` has issues with parsing Migen/gateware code, ignore as necessary. | ||
- [ ] Test your changes or have someone test them. Mention what was tested and how. | ||
- [ ] Add and check docstrings and comments | ||
- [ ] Check, test, and update the conda recipes in [conda/](../doc/) | ||
- [ ] Check, test, and update the [unittests in /artiq/test/](../artiq/test/) or [gateware simulations in /artiq/gateware/test](../artiq/gateware/test) | ||
|
||
### Documentation Changes | ||
|
||
- [ ] Check, test, and update the documentation in [doc/](../doc/). Build documentation (`cd doc; make html`) to ensure no errors. | ||
|
||
### Git Logistics | ||
|
||
- [ ] Split your contribution into logically separate changes (`git rebase --interactive`). Merge/squash/fixup commits that just fix or amend previous commits. Remove unintended changes & cleanup. See [tutorial](https://www.atlassian.com/git/tutorials/rewriting-history/git-rebase). | ||
- [ ] Write short & meaningful commit messages. Review each commit for messages (`git show`). Format: | ||
``` | ||
[topic]: description. < 50 characters total. | ||
Longer description. < 70 characters per line | ||
``` | ||
## Description of Changes | ||
|
||
### Related Issue | ||
|
||
<!-- | ||
If this PR fixes a particular issue, use the following to automatically close that issue | ||
once this PR gets merged: | ||
Closes #XXX | ||
--> | ||
|
||
## Type of Changes | ||
|
||
<!-- Leave ONLY the corresponding lines for the applicable type of change: --> | ||
| | Type | | ||
| ------------- | ------------- | | ||
| ✓ | :bug: Bug fix | | ||
| ✓ | :sparkles: New feature | | ||
| ✓ | :hammer: Refactoring | | ||
| ✓ | :scroll: Docs | | ||
|
||
|
||
### Licensing | ||
|
||
See [copyright & licensing for more info](https://github.com/m-labs/artiq/blob/master/CONTRIBUTING.rst#copyright-and-sign-off). | ||
ARTIQ files that do not contain a license header are copyrighted by M-Labs Limited and are licensed under LGPLv3+. |