ihesp / IPART

Image-Process based Atmospheric River Tracking (IPART) algorithms
https://ipart.readthedocs.io/en/latest/
GNU General Public License v3.0
24 stars 8 forks source link

Community Guidlines #6

Closed rabernat closed 4 years ago

rabernat commented 4 years ago

This issue is in reference to my JOSS review (https://github.com/openjournals/joss-reviews/issues/2407)

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

I didn't find this information in your docs. However, it does appear to be in your README.

If you encounter problems or would like to help improve the code, please don't hesitate to fire up an issue or pull request.

This is a pretty terse contributor guide. You may wish to elaborate it a bit.

Xunius commented 4 years ago

Please checkout this commit, I copied from https://github.com/neurohackademy/nh2020-curriculum/blob/master/tu-python-libraries-rokem/03-setup-file.md

Xunius commented 4 years ago

@kbarnhart What further changes need to be done regarding this issue?

kbarnhart commented 4 years ago

@Xunius it looks to me like this has been addressed. I don't believe I have privileges to close the issue, but it looks like it can be closed.

rabernat commented 4 years ago

Great, this is definitely a big improvement. I just have one recommendation: when you reference the project's GitHub page and issue tracker in the docs, provide a hyperlink so it's easier for users to find them.

I copied from https://github.com/neurohackademy/nh2020-curriculum/blob/master/tu-python-libraries-rokem/03-setup-file.md

If you are copying directly from another package, you will need to provide proper attribution. Unfortunately the licensing on the neurohackacademy repo is not clear (see https://github.com/neurohackademy/nh2020-curriculum/issues/42).

kbarnhart commented 4 years ago

@Xunius it looks like @rabernat's issue (neurohackademy/nh2020-curriculum#42) has clarified the license on the neurohackacademy. Once you have provided appropriate attribution for the contribution guidelines I think this issue can be closed.

Xunius commented 4 years ago

@rabernat @kbarnhart. Hi all, I've just added attribution to neurohackacademy in this commit.