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

Expand Contributing.md to invite contributions #83

Closed
gassmoeller opened this issue Nov 14, 2024 · 2 comments
Closed

Expand Contributing.md to invite contributions #83

gassmoeller opened this issue Nov 14, 2024 · 2 comments

Comments

@gassmoeller
Copy link
Contributor

The current contributing.md is a bit short. It sets some guidelines for contributions and discusses the process for users already familiar with contributing to github projects, but little else. For a small project like this a 10 page Contributing.md is maybe too much, but a bit of additional information would be good. E.g. the sentence This project welcomes and values your contributions. means a lot for potential contributors. Since most of this test is templateable there are good examples out there, e.g. maybe you can take over some of the text from https://contributing.md/example/.

Related to openjournals/joss-reviews#7357.

@gassmoeller
Copy link
Contributor Author

Oh I just found the following in README.md: Contributions are more than welcome using the fork and pull request approach. which is a good start, but should be repeated in the Contributing.md. Still the text of Contributing.md should be extended.

Just to clarify, the JOSS criteria for contributing statements are: 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

@daavid00
Copy link
Collaborator

daavid00 commented Dec 4, 2024

Thanks @gassmoeller for your comment.

Now the CONTRIBUTING.md includes (after the PR #97) information about:

  • Contribute to the software
  • Report issues or problems with the software
  • Seek support

In addition, in the section for Contribute to the software, information of how to run the tests locally is added.

A new Section in the documentation has been also created for the Contributing guidelines (after the PR #99):

https://opm.github.io/pyopmspe11/contributing.html

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

No branches or pull requests

2 participants