[JOSS] Community Guidelines
Closed this issue · 0 comments
nhejazi commented
The JOSS review requires "Are there clear guidelines for third parties wishing to 1) Contribute to the software 2) Report issues or problems with the software 3) Seek support." The current contributions section (https://github.com/grf-labs/policytree#contributing) appears to be insufficient for this purpose. The currently included issue template is a good start but there directions for contributing to the software could be improved. To resolve this, I would recommend
- adding a section in the
README
clearly pointing to issues -- e.g., https://github.com/nhejazi/medshift#issues; - adding a document that describes the workflow for contributing (possibly including community expectations) -- e.g., https://github.com/nhejazi/medshift/blob/master/CONTRIBUTING.md;
- updating the section in the
README
to clearly point to the document outlining contribution guidelines and community expectations -- e.g., https://github.com/nhejazi/medshift#contributions.
The above are examples of convenience (from my own work), but many alternative approaches are also perfectly acceptable.