search

chnm / Datascribe-module

An Omeka S module for the transcription of structured data.
GNU General Public License v3.0
15 stars 4 forks source link

[JOSS] Consider adding a CONTRIBUTING.md file #132

Closed koenedaele closed 11 months ago

koenedaele commented 1 year ago

Part of openjournals/joss-reviews#5661

It's best practice for FOSS to include a CONTRIBUTING.md file, that describes (briefly) how to 1) Contribute to the software 2) Report issues or problems with the software 3) Seek support. It does not need to contain everything, but some major warnings and links to other parts of your documentation to make sure people pick up on your guidelines. A major advantage of a CONTRIBUTING.md file is that it will be shown to everybody sending a PR, leading to better PR's.

Some docs can be found at https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors or https://mozillascience.github.io/working-open-workshop/contributing/

jmotis commented 1 year ago

@lmullen I've added a first draft of this file, let me know if you think we need to make any updates

koenedaele commented 1 year ago

Thank you for adding this. Huge improvement!