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

Add a CONTRIBUTING.md file or instructions for contributors? #11

Closed
kinow opened this issue Nov 2, 2020 · 3 comments
Closed

Add a CONTRIBUTING.md file or instructions for contributors? #11

kinow opened this issue Nov 2, 2020 · 3 comments

Comments

@kinow
Copy link
Contributor

kinow commented Nov 2, 2020

Hi

From openjournals/joss-reviews#2791

Just wondering if there are any plans to document how others can contribute to s4rdm3x? Related to the following topic in the review process

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

Or maybe there's something already in the docs that I've missed?

Thanks!

@h0bb3
Copy link
Owner

h0bb3 commented Nov 2, 2020

There is a small section at the end of the docs: https://tobias-dv-lnu.github.io/s4rdm3x/

The main way of continuing development is to write new mappers: the main steps to do so is documented in: https://tobias-dv-lnu.github.io/s4rdm3x/add_new_mapper

Maybe this should be made clearer in some way...

@kinow
Copy link
Contributor Author

kinow commented Nov 2, 2020

Sorry, I missed that part @tobias-dv-lnu . I think a simple short paragraph or link to the section on how to contribute/write a custom mapper could be useful, or what do you expect from the contribution (e.g. include tests? add javadocs to important methods/code added, etc?).

But good enough for the paper review 👍 plus I consider the vast amount of tests and the example experiment provided good ways to help users how to contribute too (i.e. by example). Feel free to close it if you'd like 👍

@h0bb3
Copy link
Owner

h0bb3 commented Nov 2, 2020

Good point! I will add a docs issue for this!

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