adding a simple instuctions for developers#117
Conversation
There was a problem hiding this comment.
Code Review
This pull request rebrands the project to StructSense and introduces a detailed developer guide. Feedback includes linking the CI page in the contribution guidelines, standardizing Python version ranges, lowering the Poetry version requirement for better contributor compatibility, and moving inline comments in the environment variable examples to separate lines to prevent potential parsing errors.
|
|
||
| 1. **Unit tests**, **documentation**, and **code style** are in order. | ||
| See the Continuous Integration for up to date information on the current code style, tests, and any other requirements. | ||
| See the [Developer Guide](DEVELOPER.md) for setup instructions and the Continuous Integration for up-to-date requirements. |
There was a problem hiding this comment.
It would be helpful to link the "Continuous Integration" text to the project's CI page (e.g., GitHub Actions) so contributors can easily check the status and requirements.
| See the [Developer Guide](DEVELOPER.md) for setup instructions and the Continuous Integration for up-to-date requirements. | |
| See the [Developer Guide](DEVELOPER.md) for setup instructions and the [Continuous Integration](https://github.com/sensein/structsense/actions) for up-to-date requirements. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #117 +/- ##
=======================================
Coverage 15.48% 15.48%
=======================================
Files 28 28
Lines 6850 6850
=======================================
Hits 1061 1061
Misses 5789 5789 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
it should be merged by #116
I'm using
poetrysince this is the part of the project