search

ucl-exoplanets / ExoTETHyS

GNU General Public License v3.0
17 stars 3 forks source link

Community Guidelines #12

Closed steven-murray closed 4 years ago

steven-murray commented 4 years ago

Part of JOSS review:

It is currently hard to know how to contribute to the repository. There are no explicit instructions, and the workings of the package are rather opaque (also due to #9).

It would be highly beneficial to create a simple CONTRIBUTING.md file, which outlines how to contribute to the software, how to make issues, etc.

gmorello commented 4 years ago

I created a basic CONTRIBUTING.md file. Is that ok?

steven-murray commented 4 years ago

It is very basic, and I encourage further additions to it, but it exists!

gmorello commented 4 years ago

Ok, thanks. If you would like to point at some examples with other ways of contributing that I can consider, but at least this issue is not critical for releasing the first static version outside GitHub.

steven-murray commented 4 years ago

Here's an example of what I consider to be a fairly complete contributing guide, that you'd probably have to prune a bit: https://github.com/RadioAstronomySoftwareGroup/pyuvdata/blob/master/.github/CONTRIBUTING.md