diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 51 |
1 files changed, 32 insertions, 19 deletions
@@ -17,7 +17,8 @@ encourage contributions, for example, by forking the repository, making your changes to the code, and issuing a pull request. Currently, GEMMA is supported for 64-bit Mac OS X and Linux -platforms. *Windows is not currently supported.* If you are interested +platforms. *Windows is not currently supported.* though you can +run GEMMA in a Linux VM or [container](https://docs.docker.com/docker-for-windows/). If you are interested in helping to make GEMMA available on Windows platforms (e.g., by providing installation instructions for Windows, or by contributing Windows binaries) please post a note in the @@ -174,27 +175,39 @@ 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/installation 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. + +### 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. +2. [ ] I have searched for it on the [issue tracker](https://github.com/genetics-statistics/GEMMA/issues?q=is%3Aissue) (incl. closed issues) +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/install 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 |