Skip to content

- Development

This section is intended to all developers who want to contribute to the project by:

  • fixing one or more bugs
  • improving the library
  • creating a new Interaction

Depending on the scope, different actions should be taken into consideration.

Since you are reading this section, it could mean that you want to contribute to the project by improving the library, for this reason I want to say... Thank You!

Claude Code Skills

Developers using Claude Code can take advantage of two project skills that enforce library conventions automatically:

Skill Purpose
cyhole-git-commit-convention Enforces the CODE: Title commit message format on every commit. Use during the development phase whenever creating a git commit.
cyhole-writing-documentation Enforces documentation structure and style conventions. Use whenever new functionality is added or existing behaviour changes.

These skills are available inside the .claude/skills/ folder of the repository and are loaded automatically by Claude Code when working in this project.

  • New Interaction

    Extend the library by implementing an Interaction.

    Reference

  • Bug & Improvements

    Correct a bug or improve the library by proposing new ideas.

    Reference

  • Testing

    Understand how the tests are managed inside the library.

    Reference

  • Pull Requests

    Prepare your code to be merged.

    Reference

Latest Library Version

To use locally the latest version of the library not yet released:

  • clone or fork the repository
  • activate the python environment you want to use
  • navigate to the root folder of the library
  • run the command pip install -e .

By using these commands, you will have the latest cyhole version of the library on the desired environment.

Note

The latest version is under development, and for this reason it could be unstable or having bugs.