aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPjotr Prins2017-10-26 08:20:41 +0000
committerPjotr Prins2017-10-26 08:20:41 +0000
commit7eaf452c8b5faf99d335d6f354bbf4e67d1c2f19 (patch)
tree4e1fc80a1f4a177dd80ff4a58d0077220844dee3
parent3f2ebeba716ccc04f08e4245db4ffbc377c10206 (diff)
downloadpangemma-7eaf452c8b5faf99d335d6f354bbf4e67d1c2f19.tar.gz
README: added mailing list and updated text
-rw-r--r--README.md47
1 files changed, 30 insertions, 17 deletions
diff --git a/README.md b/README.md
index d5d2f38..d7324a1 100644
--- a/README.md
+++ b/README.md
@@ -174,27 +174,40 @@ found in [INSTALL.md](INSTALL.md).
## Reporting a GEMMA bug or issue
-GEMMA has an
+For bugs GEMMA has an
[issue tracker](https://github.com/genetics-statistics/GEMMA/issues)
-on github. Before posting an issue search the issue tracker first. It
-is likely someone may have encountered something similiar. Also try
-running the latest version of GEMMA to make sure it has not been fixed
-already. When reporting an issue include the output of the program and
-the contents of the .log.txt file in the output directory. We may ask
-you for your data to resolve the issue (treated confidentially). Check
-list:
+on github. For general support GEMMA has a mailing list at
+[gemma-discussion](https://groups.google.com/forum/#!forum/gemma-discussion)
+
+Before posting an issue search the issue tracker and mailing list
+first. It is likely someone may have encountered something
+similiar. Also try running the latest version of GEMMA to make sure it
+has not been fixed already. Support questions should be aimed at the
+mailing list. The issue tracker is for development issues around the
+software itself. When reporting an issue include the output of the
+program and the contents of the .log.txt file in the output
+directory. We may ask you for your data to resolve the issue (treated
+confidentially).
+
+### Check list:
1. [X] I have found and issue with GEMMA
2. [ ] I have searched for it on the [issue tracker](https://github.com/genetics-statistics/GEMMA/issues) (incl. closed issues)
-3. [ ] I have tried the latest release of GEMMA
-4. [ ] I have posted a new issue on the issue tracker or added to an existing one
-5. [ ] I have included the output of GEMMA
-6. [ ] I have included the relevant .log.txt file in the output directory
-7. [ ] I have made available the data to reproduce the problem (optional)
-
-Please always remember that GEMMA is written and maintained by
-volunteers with good intentions. Our time is valuable too. By helping
-us as much as possible we can provide this tool for everyone to use.
+3. [ ] I have searched for it on the [mailing list](https://groups.google.com/forum/#!forum/gemma-discussion)
+4. [ ] I have tried the latest [release](https://github.com/genetics-statistics/GEMMA/releases) of GEMMA
+5. [ ] I have read and agreed to below code of conduct
+6. [ ] If it is a support question I have posted it to the [mailing list](https://groups.google.com/forum/#!forum/gemma-discussion)
+7. [ ] If it is software development related I have posted a new issue on the [issue tracker](https://github.com/genetics-statistics/GEMMA/issues) or added to an existing one
+8. [ ] In the message I have included the output of my GEMMA run
+9. [ ] In the message I have included the relevant .log.txt file in the output directory
+10. [ ] I have made available the data to reproduce the problem (optional)
+
+To find bugs the GEMMA software developers may ask to install a
+development version of the software. They may also ask you for your
+data and will treat it confidentially. Please always remember that
+GEMMA is written and maintained by volunteers with good
+intentions. Our time is valuable too. By helping us as much as
+possible we can provide this tool for everyone to use.
## Code of conduct