[JOSS REVIEW]: Add Contributing guidelines

[finsberg]

As a part the JOSS submission you should provide clear guidelines for third-parties wishing to:

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

While you have mentioned in the README that contributors should engage through the GitHub repository, I do think it would be good with more information about this. For example you could add a CONTRIBUTING.md with instructions on whether authors should first open an issue, do you want contributors to add tests / documentation, should contributors follow any particular code styles etc (you can of course also provide this information elsewhere if you feel that is more natural).

For users that want to report issues or seek support, it might be good to add a link to the issue tracker.

This issue is related to the review here: openjournals/joss-reviews#7307

[CastillonMiguel]

I appreciate your suggestions on providing clearer guidelines for contributors and users.

I have created a CONTRIBUTING.rst file that includes detailed instructions on how to contribute, report issues, and seek support, along with information on code style and testing.

Additionally, I’ve added a link to the issue tracker in the README for easier access.

See commit Add Contributing guidelines, and Update README for the changes.

[finsberg]

Thanks @CastillonMiguel! This looks very good. One question related to the guide is this line: Add tests for any new features or bug fixes. To me it is not quite clear how a user should add a test.

[CastillonMiguel]

For now, the way to test is by running and checking the new examples. I haven’t added detailed instructions yet. Regarding automated tests, I think the best approach is to first complete issue #3, and then I will update the guide with the correct instructions for adding new tests.

[CastillonMiguel]

I have added a new section to the contributing guide outlining how to write and organize tests. 5ab9745