Skip to content

Add and extend contributing guidelines to README.md #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
cosimameyer opened this issue Dec 21, 2022 · 1 comment
Closed

Add and extend contributing guidelines to README.md #13

cosimameyer opened this issue Dec 21, 2022 · 1 comment

Comments

@cosimameyer
Copy link

Specific ontributor guidelines exist on the package's website. Making them also transparent in your GitHub README.md would be fantastic (I think most people will use the GitHub repository as the landing page to explore more information on the package and there's currently only a general "Code of Conduct" that does not address where to address how to explicitly "1) Contribute to the software 2) Report issues or problems with the software 3) Seek support").

Similarly, making clear how to seek support (for instance, by opening an issue) would provide (new) users with good guidance. It's a suggestion, but we added it to our package README this way throughout the review process at JOSS and I think it was a good suggestion by our reviewer.

(This issue is part of the review openjournals/joss-reviews#4987)

@schochastics
Copy link
Owner

I like what you did there. Hope you dont mind me copy pasting this :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants