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

Contributor instructions for testing and style #62

Closed
drcandacemakedamoore opened this issue Mar 18, 2024 · 1 comment
Closed

Contributor instructions for testing and style #62

drcandacemakedamoore opened this issue Mar 18, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@drcandacemakedamoore
Copy link

There is no obvious developer's documentation. The contributing.md would be fine except does not cover certain issues i.e. testing and linting. Many people may want to tinker with what you have done, and hopefully even contribute to the package. I am looking for documentation somewhere that tells people how to run the testing, so they can test new stuff before sending it. I eventually say some notes on contributing, somewhere. This could be in a more obvious place i.e. linked off the README, but the contributing.md is also fine as a stand-alone. Just a few more details please.

@alexzwanenburg alexzwanenburg added the documentation Improvements or additions to documentation label Mar 18, 2024
@alexzwanenburg alexzwanenburg added this to the v2.2.0 milestone Mar 18, 2024
@alexzwanenburg alexzwanenburg self-assigned this Mar 18, 2024
@alexzwanenburg
Copy link
Member

alexzwanenburg commented Mar 18, 2024

Thanks for the feedback!

I will add instructions on style and testing to contributing.md, and link that file in README.md.

openjournals/joss-reviews#6413

@alexzwanenburg alexzwanenburg changed the title testing Contributor instructions for testing and style Mar 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants