search

Deech08 / whampy

Python Package to Interact with, Visualize, and Analyze the Wisconsin H-Alpha Mapper - Sky Survey
BSD 3-Clause "New" or "Revised" License
8 stars 1 forks source link

Community Guidelines #6

Closed HeloiseS closed 4 years ago

HeloiseS commented 4 years ago

One of the requirements for JOSS publication is the presence of clearly stated Community Guidelines

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

This could be added to a section in the README - feel free to inspire yourself from the astropy stuff :) This should be a quick fix

This issue is part of the current JOSS-review of whampy ( #1940 )

Deech08 commented 4 years ago

I am planning to add a section to the README like the following. I believe this will satisfy those requirements. I previously had some brief text on the repo's "Wiki" page but see that it isn't very clearly located. I added a couple issue templates to assist with the reporting process as well.

Contributing

Contributions, feedback, and bug reports are welcome from all users of whampy! If you discover a bug, or have a request for a new feature, please open an issue on this repository using one of the templates. If you would like to make a more direct contribution to the code, please submit a pull request to this repository. This package relies upon the work of the astropy team, and we also ask that all contributions follow the Astropy Community Code of Conduct <https://www.astropy.org/about.html#codeofconduct>_.