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

[joss][docs] Developer docs #17

Closed
2 tasks
sneakers-the-rat opened this issue Feb 19, 2024 · 3 comments
Closed
2 tasks

[joss][docs] Developer docs #17

sneakers-the-rat opened this issue Feb 19, 2024 · 3 comments

Comments

@sneakers-the-rat
Copy link

Part of: openjournals/joss-reviews#6336

Collecting ideas for developer docs here rather than in separate issues. Trying to minimize nags and only focus on things that I think would be helpful for inviting contributors and allowing for maintenance

  • How to run tests? (looks pretty standard, npm install && npm run test)
  • Expectations for contributions in Contributing.md - "test new functionality, run tests, etc."
  • ... (will update as i continue to read)
@katjaq
Copy link
Member

katjaq commented Mar 19, 2024

Thank you! We have now added to the Contributing.md in commit 6e74c28:

Test new functionalities

If you would like to change the code, please make sure the existing tests run using npm install && npm run test.
If you add a new functionality, please also implement new test(s) to make sure of its correct working. Thank you.

@sneakers-the-rat
Copy link
Author

Fabulous! That's pretty much all i came up with as i was reading! feel free to close

@katjaq
Copy link
Member

katjaq commented Apr 3, 2024

Great :) Thank you.

@katjaq katjaq closed this as completed Apr 3, 2024
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