Skip to content
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

Elaborate contributing guidelines #385

Closed
ashwinvis opened this issue Oct 28, 2023 · 2 comments · Fixed by #398
Closed

Elaborate contributing guidelines #385

ashwinvis opened this issue Oct 28, 2023 · 2 comments · Fixed by #398

Comments

@ashwinvis
Copy link

https://vergauwenthomas.github.io/MetObs_toolkit/MetObs_documentation_full.html

I think this is very short. According to JOSS and I agree

There should be clear guidelines for third-parties wishing to:

Contribute to the software

Report issues or problems with the software

Seek support

See here for some general guidelines

https://www.pyopensci.org/python-package-guide/documentation/repository-files/contributing-file.html

cf: openjournals/joss-reviews#5916

@Zeitsperre
Copy link
Contributor

Hi @vergauwenthomas, I'm going to also jump in and agree that the contribution guidelines aren't clear. These should be found in the top-level of the project as well as be somewhere in the documentation (maybe near the developer documentation).

This is an example from one of the projects I develop/maintain: https://github.com/CSHS-CWRA/RavenPy/blob/master/CONTRIBUTING.rst (No need to follow this to the letter, but more for inspiration)

@vergauwenthomas vergauwenthomas linked a pull request Nov 14, 2023 that will close this issue
@vergauwenthomas
Copy link
Owner

A CONTRIBUTING file is added to the repo + is rendered in the documentation.

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

Successfully merging a pull request may close this issue.

3 participants