Skip to content

Latest commit

 

History

History
63 lines (40 loc) · 1.65 KB

CONTRIBUTING.rst

File metadata and controls

63 lines (40 loc) · 1.65 KB
Raw

Contributing to fluent-compiler

Issues

You can help by filing bugs on GitHub: https://github.com/django-ftl/fluent-compiler/issues.

Please check existing issues before filing a new one.

Development environment

To contribute fixes and features, you'll need to get set up for development:

  1. Fork fluent_compiler on GitHub.

  2. Clone and go to the forked repository.

  3. Create and activate a virtual environment for development (or your preferred mechanism for isolated Python environments).

  4. Install the package in development mode:

    pip install -e .

  5. Install test requirements:

    pip install -r requirements-test.txt

  6. Run the tests:

    pytest

If all that is successful, you are in good shape to start developing!

We also have several linters and code formatters that we require use of, including ruff and black. These are most easily added by using pre-commit:

  • Install pre-commit globally e.g. pipx install pre-commit if you already have pipx.
  • Do pre-commit install in the repo.

Now all the linters will run when you commit changes.

To run tests on multiple Python versions locally you can also install and use tox.

Fixes and features

Please submit fixes and features by:

  1. First creating a branch for your changes.
  2. Sending us a PR on GitHub.

For new features it is often better to open an issue first to see if we agree that the feature is a good idea, before spending a lot of time implementing it.