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

Update README with poetry setup and contributing guidelines #698

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

zzadxz
Copy link

@zzadxz zzadxz commented Oct 30, 2024

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 of python3 -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

  • My code follows the project’s coding style and guidelines.
  • I have run pre-commit hooks to ensure code quality.
  • Documentation has been updated as needed.
  • This change does not break any existing functionality.

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.

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

Successfully merging this pull request may close these issues.

1 participant