Contributing guidelines

vsoch / gridtest

grid parameters and testing for Python modules and functions

https://vsoch.github.io/gridtest/

Mozilla Public License 2.0

2 stars 1 forks source link

Contributing guidelines #31

Closed cbrueffer closed 4 years ago

cbrueffer commented 4 years ago

Description

Tthe Community guidelines section of the JOSS review mentions instructions for contributors to the software. Adding a contributing file as per https://help.github.com/en/github/building-a-strong-community/setting-guidelines-for-repository-contributors would cover this.

vsoch commented 4 years ago

I'd be happy to! Also note that we already have a guide in the documentation https://vsoch.github.io/gridtest/contributing/index.html. Would you prefer a standard CONTRIBUTING.md added, or perhaps a link to that page in the README?

cbrueffer commented 4 years ago

Of course only after opening the PR I see https://vsoch.github.io/gridtest/contributing/index.html

Maybe the whole guide can be made a bit more prominent in the README, perhaps with its own section.

cbrueffer commented 4 years ago

To me, specific sections in the README are usually best, since they are very visible. I think the information in the guide is fine, so no CONTRIBUTING file is needed.

vsoch commented 4 years ago

okay! Let's do both then. Give me a minute or two!

vsoch commented 4 years ago

All set! https://github.com/vsoch/gridtest/commit/002de28e6529d99082baab9864027974c3c361a5 I did the following:

added a CONTRIBUTING.md guide which has more of a "PR checklist" along with code of conduct
linked to the "how to contribute to docs and code" in the README, along with the link to the checklist.

I figure there are two use cases to wanting to contribute - either wanting the checklist (CONTRIBUTING.md) or the pretty, rendered guide, so we can link to both.

cbrueffer commented 4 years ago

Looks good, thanks! I think moving the pointer to the documentation from the end of the overview to its own Documentation section would be good to make it more obvious. It gets a bit lost in its current location.

vsoch commented 4 years ago

Sure thing. Also note that the link is right at the top (I usually look for it there)

vsoch commented 4 years ago

Added to the top!

cbrueffer commented 4 years ago

Didn't even notice that! It's probably a very personal thing on what we focus on first when skimming a repo.

vsoch commented 4 years ago

I think so too - it's one of those things that would be really interesting to study, but one would never be able to get funding for it. Actually, maybe GitHub does private testing of something like that.

cbrueffer commented 4 years ago

Off-topic for this PR but I noticed that gridtest isn't tested using gridtest from the CI, is there a reason for that?

Edit: again, only noticed test_client.sh after hitting send.

vsoch commented 4 years ago

No worries!

cbrueffer commented 4 years ago

Addressed in https://github.com/vsoch/gridtest/commit/002de28e6529d99082baab9864027974c3c361a5, https://github.com/vsoch/gridtest/commit/7d97d88fdefe6554158b403db22ef1dc31b0ab79, and https://github.com/vsoch/gridtest/commit/38dad3a2f5eeac70178158c258b5e874c83b8621