Update README with poetry setup and contributing guidelines #698
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Type (Documentation)
Short Description
This PR updates the README to clarify the setup process for Poetry and provide clearer contribution guidelines. It simplifies the environment setup instructions by using
poetry install
instead ofpython3 -m poetry install
which causes errors. Now cyclops should be reproducible. Additional instructions for testing dependencies and building API documentation with Sphinx have also been clarified.Linked Issues
None currently.
Tests Added
Not applicable – no code changes introduced in this PR outside of README.md.
Checklist
Additional Notes
This README update aims to improve the onboarding experience for new developers who clone the repository by fixing setup commands to reduce potential errors during the initial setup.