wip: add test refernce #180
Conversation
|
Thank you for submitting this pull request! We appreciate your contribution to the project. Before we can merge it, we need to review the changes you've made to ensure they align with our code standards and meet the requirements of the project. We'll get back to you as soon as we can with feedback. Thanks again! |
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @aaronm-2112 - I've reviewed your changes and they look great!
General suggestions:
- Ensure that all placeholders and notes for future additions, such as the ones from the latest JOSS response, are resolved or tracked outside of the main documentation to maintain clarity.
- Consider adding rationales for the prioritization of test types to help contributors understand the project's testing philosophy.
- Provide examples or snippets on how to mock API requests effectively, as this is a crucial part of maintaining test isolation and avoiding unintended side effects.
Here's what I looked at during the review
- 🟡 General issues: 3 issues found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Docstrings: all looks good
Thanks for using Sourcery. We offer it for free for open source projects and would be very grateful if you could help us grow. If you like it, would you consider sharing Sourcery on your favourite social media? ✨
No description provided.