From 2183dcf23e1e7051bf19a826ae58d8df0a714d0f Mon Sep 17 00:00:00 2001
From: Sebastien Bourdeauducq <sb@m-labs.hk>
Date: Fri, 14 Jun 2019 11:20:42 +0800
Subject: [PATCH] update contributing and issue instructions

---
 .github/ISSUE_TEMPLATE/1_Bug_Report.md |  7 +++----
 .github/ISSUE_TEMPLATE/3_Question.md   |  8 +++++---
 .github/pull_request_template.md       |  1 -
 CONTRIBUTING.rst                       | 24 +++++++++++-------------
 4 files changed, 19 insertions(+), 21 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE/1_Bug_Report.md b/.github/ISSUE_TEMPLATE/1_Bug_Report.md
index db5f35bf6..263b34f86 100644
--- a/.github/ISSUE_TEMPLATE/1_Bug_Report.md
+++ b/.github/ISSUE_TEMPLATE/1_Bug_Report.md
@@ -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:
 
 <!--
diff --git a/.github/ISSUE_TEMPLATE/3_Question.md b/.github/ISSUE_TEMPLATE/3_Question.md
index 10f3f616f..6a0328269 100644
--- a/.github/ISSUE_TEMPLATE/3_Question.md
+++ b/.github/ISSUE_TEMPLATE/3_Question.md
@@ -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/
 
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 43e978157..55e829cc4 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -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
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 5b4ed45a9..8fa7d0336 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -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