Community guidelines for reporting issues and support queries
matt-graham opened this issue · comments
Raising as part of JOSS review openjournals/joss-reviews/issues/5901
Ideally you should some clear and easily findable guidelines for how to report issues and seek support with the software.
This section in the user manual page in the documentation
already partially fits the bill, but
- It took a little while for me to find - I would put it somewhere more prominent, for example in a dedicated top-level documentation page or in README
- The reference to 'discussions section' is not very clear - I assume this means GitHub Discussions but from documentation website it wouldn't necessarily be clear how to get there so adding a link would be useful.
- A brief description and pointer to the GitHub issue tracker as (presumably) the correct place to report issues with the code, and perhaps some explanation of the different issue templates / categories.