Skip to content

Latest commit

 

History

History
22 lines (15 loc) · 933 Bytes

CONTRIBUTING.md

File metadata and controls

22 lines (15 loc) · 933 Bytes

Contributing to Picodi

Thank you for considering contributing to Picodi! Below are some guidelines to help you get started.

Making Changes

  1. After cloning the repository, install dependencies by running poetry install. This will create a virtual environment in project directory and install all dependencies.
  2. Make your changes.
  3. If you are adding new functionality, add tests for it.
  4. Run tests with make test.
  5. Run linters with make lint.
  6. If you are making changes to the readme or documentation, run make test-docs and make docs.

Reporting Issues

If you find any bugs or have feature requests, please open an issue on the GitHub Issues page. Provide as much detail as possible to help us understand and address the issue.

License

By contributing to Picodi, you agree that your contributions will be licensed under the MIT License.