Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
102 lines (67 loc) · 2.55 KB

CONTRIBUTING.md

File metadata and controls

102 lines (67 loc) · 2.55 KB
Raw

How to contribute

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/saritasa-nest/saritasa-invocations/issues.

If you are reporting a bug, please include:

  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with bug and help wanted is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with enhancement and help wanted is open to whoever wants to implement it.

Write Documentation

saritasa-invocations could always use more documentation, whether as part of the official saritasa-invocations docs, in docstrings, or even on the web in blog posts, articles, and such.

The best way to send feedback is to file an issue at https://github.com/saritasa-nest/saritasa-invocations/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started

Ready to contribute? Here's how to set up saritasa-invocations for local development.

Fork the saritasa-invocations repo on GitHub. And then clone your fork locally:

git clone git@github.com:your_name_here/saritasa-invocations.git

Then, navigate to the project directory:

cd saritasa-invocations

Setup virtual environment

We use uv to manage the dependencies.

To set up venv you would need to run sync command:

uv sync --all-packages --all-groups --all-extras

To activate your virtualenv

source .venv/bin/activate

Check code

We use pre-commit for quality control.

To run checks:

inv pre-commit.run-hooks

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.md.
  3. The pull request should work for each supported Python version. Check github actions status, verify that all checks have been passed.