mirror of
https://github.com/m-labs/artiq.git
synced 2024-12-24 02:44:01 +08:00
update contributing and issue instructions
This commit is contained in:
parent
636b4cae5a
commit
2183dcf23e
7
.github/ISSUE_TEMPLATE/1_Bug_Report.md
vendored
7
.github/ISSUE_TEMPLATE/1_Bug_Report.md
vendored
@ -8,7 +8,7 @@ about: Report a bug in ARTIQ
|
||||
|
||||
# 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.
|
||||
<!-- 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 [forum](https://forum.m-labs.hk). Please check Github/those forums to avoid posting a repeat issue.
|
||||
|
||||
Context helps us fix issues faster, so please include the following when relevant:
|
||||
-->
|
||||
@ -34,13 +34,12 @@ Behavior
|
||||
* Text description
|
||||
* Log message, tracebacks, screen shots where relevant
|
||||
|
||||
### Your System
|
||||
### Your System (omit irrelevant parts)
|
||||
|
||||
* Operating System:
|
||||
* ARTIQ version: (with recent versions of ARTIQ, run ``artiq_client --version``)
|
||||
* Version of the gateware and runtime loaded in the core device: (in the output of ``artiq_coremgmt -D .... log``)
|
||||
* If using Nix, version of nixpkgs (run ``nix-instantiate --eval -E '(import <nixpkgs> {}).lib.version'``):
|
||||
* If using Conda, output of `conda list`:
|
||||
* If using Conda, output of `conda list` (please submit as a file attachment, as this tends to be long)
|
||||
* Hardware involved:
|
||||
|
||||
<!--
|
||||
|
8
.github/ISSUE_TEMPLATE/3_Question.md
vendored
8
.github/ISSUE_TEMPLATE/3_Question.md
vendored
@ -1,6 +1,6 @@
|
||||
---
|
||||
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/)
|
||||
about: Questions about ARTIQ that are not covered in the documentation. The forum is also a very good place for questions: https://forum.m-labs.hk/
|
||||
|
||||
---
|
||||
|
||||
@ -9,9 +9,11 @@ about: Questions about ARTIQ that are not covered in the documentation. (Latest
|
||||
<!--
|
||||
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/
|
||||
|
||||
Beta version: https://m-labs.hk/artiq/manual-beta/
|
||||
Stable version: https://m-labs.hk/artiq/manual/
|
||||
|
||||
The forum is also a very good place for questions: https://forum.m-labs.hk/
|
||||
Can also ask on IRC: https://webchat.freenode.net/?channels=m-labs or
|
||||
check mailing list archives: https://ssl.serverraum.org/lists-archive/artiq/
|
||||
|
||||
|
1
.github/pull_request_template.md
vendored
1
.github/pull_request_template.md
vendored
@ -47,7 +47,6 @@ Closes #XXX
|
||||
- [ ] 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
|
||||
|
@ -8,8 +8,8 @@ Reporting Issues/Bugs
|
||||
Thanks for `reporting issues to ARTIQ
|
||||
<https://github.com/m-labs/artiq/issues/new>`_! 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 `mailing list
|
||||
<https://ssl.serverraum.org/lists/listinfo/artiq>`_.
|
||||
<https://webchat.freenode.net/?channels=m-labs>`_), the `Mattermost chat
|
||||
<https://chat.m-labs.hk>`_, or on the `forum <https://forum.m-labs.hk>`_.
|
||||
|
||||
The best bug reports are those which contain sufficient information. With
|
||||
accurate and comprehensive context, an issue can be resolved quickly and
|
||||
@ -17,19 +17,20 @@ efficiently. Please consider adding the following data to your issue
|
||||
report if possible:
|
||||
|
||||
* A clear and unique summary that fits into one line. Also check that
|
||||
this issue has not jet been reported. If it has, add additional information there.
|
||||
this issue has not yet been reported. If it has, add additional information there.
|
||||
* Precise steps to reproduce (list of actions that leads to the issue)
|
||||
* Expected behavior (what should happen)
|
||||
* Actual behavior (what happens instead)
|
||||
* Logging message, trace backs, screen shots where relevant
|
||||
* Components involved:
|
||||
* Components involved (omit irrelevant parts):
|
||||
|
||||
* Operating system
|
||||
* Conda version
|
||||
* ARTIQ version (package or git commit id, versions for bitstream, BIOS,
|
||||
runtime and host software)
|
||||
* Operating System
|
||||
* ARTIQ version (with recent versions of ARTIQ, run ``artiq_client --version``)
|
||||
* Version of the gateware and runtime loaded in the core device (in the output of ``artiq_coremgmt -D .... log``)
|
||||
* If using Conda, output of `conda list`
|
||||
* Hardware involved
|
||||
|
||||
|
||||
For in-depth information on bug reporting, see:
|
||||
|
||||
http://www.chiark.greenend.org.uk/~sgtatham/bugs.html
|
||||
@ -42,10 +43,8 @@ Contributing Code
|
||||
ARTIQ welcomes contributions. Write bite-sized patches that can stand alone,
|
||||
clean them up, write proper commit messages, add docstrings and unittests. Then
|
||||
``git rebase`` them onto the current master or merge the current master. Verify
|
||||
that the testsuite passes. Then prepare a pull request or send patches to the
|
||||
`mailing list <https://ssl.serverraum.org/lists/listinfo/artiq>`_ to be
|
||||
discussed. Expect your contribution to be held up to coding standards (e.g. use
|
||||
``flake8`` to check yourself).
|
||||
that the testsuite passes. Then submit a pull request. Expect your contribution
|
||||
to be held up to coding standards (e.g. use ``flake8`` to check yourself).
|
||||
|
||||
Checklist for Code Contributions
|
||||
--------------------------------
|
||||
@ -67,7 +66,6 @@ Checklist for Code Contributions
|
||||
- Update ``RELEASE_NOTES.md`` if there are noteworthy changes, especially if
|
||||
there are changes to existing APIs
|
||||
- Check, test, and update the documentation in `doc/`
|
||||
- Check, test, and update the conda recipes in `conda/`
|
||||
- Check, test, and update the unittests
|
||||
- Close and/or update issues
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user