Skip to main content
Cycls is open-source, and we welcome contributions.

​
How to Contribute

  1. Fork and Clone: Fork the repo on GitHub and clone it locally.
  2. Branch: Create a new branch for your feature or bugfix.
  3. Commit: Make your changes and commit them with clear messages.
  4. Pull Request: Push your branch and open a PR against the main branch.

​
What to Contribute

Here are a few ways you can get involved:
  • Report Bugs: Open an issue on GitHub if you find something broken.
  • Suggest Features: Have an idea? Start a discussion or open a feature request issue.
  • Improve Docs: typos, unclear examples, or missing guides—all fixes are appreciated.
  • Submit Code: Check the “good first issue” label on our issue tracker for easy entry points.

​
Quality Standards

To ensure a high-quality codebase, please check the following before submitting a PR:
  • Linting: Run our linter to ensure your code style matches the project standards.
  • Tests: Add tests for any new features and ensure all existing tests pass.
  • Type Hints: We use type hints extensively. Please ensure your Python code is fully typed.

​
Code of Conduct

We are committed to providing a friendly, safe, and welcoming environment for all. Please be respectful and considerate in your interactions. Message us on Discord Community to discuss ideas, ask questions, and meet other contributors.