Skip to content

Latest commit

 

History

History
254 lines (177 loc) · 11.7 KB

CONTRIBUTING.rst

File metadata and controls

254 lines (177 loc) · 11.7 KB
Raw

Contribution Guide

Setting up the environment

Tip

Supported Python versions.

The lowest currently supported version is Python 3.8. You can use pyenv to manage multiple Python versions on your system.

We also use the lowest supported version in our type-checking CI, this ensures that the changes you made are backward compatible.

Tip

We maintain a Makefile with several commands to help with common tasks. You can run make help to see a list of available commands.

  1. Install PDM
  2. Run pdm install or make install to create a virtual environment and install the required development dependencies
  3. If you're working on the documentation and need to build it locally, install the extra dependencies with pdm install -G:docs or make docs-install
  4. Install pre-commit
  5. Run pre-commit install --install-hooks or make install to install pre-commit hooks

Tip

Many modern IDEs like PyCharm or VS Code will enable the PDM-managed virtualenv that is created in step 2 for you automatically. If your IDE / editor does not offer this functionality, then you will need to manually activate the virtualenv yourself. Otherwise you may encounter errors or unexpected behaviour when trying to run the commands referenced within this document.

To activate the virtualenv manually, please consult PDM's documentation on working with virtual environments. A simpler alternative is using the PDM plugin pdm-shell.

The rest of this document will assume this environment is active wherever commands are referenced.

Code contributions

Workflow

  1. Fork the Litestar repository
  2. Clone your fork locally with git
  3. Set up the environment
  4. Make your changes
  5. (Optional) Run pre-commit run --all-files to run linters and formatters. This step is optional and will be executed automatically by git before you make a commit, but you may want to run it manually in order to apply fixes
  6. Commit your changes to git. Note - we follow [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/), which are enforced using a pre-commit hook.
  7. Push the changes to your fork
  8. Open a pull request. Give the pull request a descriptive title indicating what it changes. The style of the PR title should also follow [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/), and this is enforced using a GitHub action.
  9. Add yourself as a contributor using the all-contributors bot

Guidelines for writing code

  • Code should be Pythonic and zen
  • All code should be fully typed. This is enforced via mypy and pyright
    • When requiring complex types, use a type alias. Check litestar/types if a type alias for your use case already exists
    • If something cannot be typed correctly due to a limitation of the type checkers, you may use typing.cast to rectify the situation. However, you should only use as a last resort if you've exhausted all other options of type narrowing, such as isinstance() checks and type guards
    • You may use type: ignore if you ensured that a line is correct, but mypy / pyright has issues with it. Don't use blank type: ignore though, and instead supply the specific error code, e.g. type: ignore[attr-defined]
  • If you are adding or modifying existing code, ensure that it's fully tested. 100% test coverage is mandatory, and will be checked on the PR using SonarCloud
  • All functions, methods, classes, and attributes should be documented with a docstring. We use the Google docstring style. If you come across a function or method that doesn't conform to this standard, please update it as you go
  • When adding a new public interface, it has to be included in the reference documentation located in docs/reference. If applicable, add or modify examples in the docs related to the new functionality implemented, following the guidelines established in Adding examples

Writing and running tests

Tests are contained within the tests directory, and follow the same directory structure as the litestar module. If you are adding a test case, it should be located within the correct submodule of tests. E.g. tests for litestar/utils/sync.py reside in tests/utils/test_sync.py.

The Makefile includes several commands for running tests:

  • make test to run tests located in tests
  • make test-examples to run tests located in docs/examples/tests
  • make test-all to run all tests
  • make coverage to run tests with coverage and generate an html report

The tests make use of pytest-xdist to speed up test runs. These are enabled by default when running make test, make test-all or make coverage. Due to the nature of pytest-xdist, attaching a debugger isn't as straightforward. For debugging, it's recommended to run the tests individually with pytest <test name> or via an IDE, which will skip pytest-xdist.

Running type checkers

We use mypy and pyright to enforce type safety. You can run them with:

  • make mypy
  • make pyright
  • make type-check to run both
  • make lint to run pre-commit hooks and type checkers.

Our type checkers are run on Python 3.8 in CI, so you should make sure to run them on the same version locally as well.

Project documentation

The documentation is located in the /docs directory and is ReST and Sphinx. If you're unfamiliar with any of those, ReStructuredText primer and Sphinx quickstart are recommended reads.

Docs theme and appearance

We welcome contributions that enhance / improve the appearance and usability of the docs. We use the excellent Furo theme, which comes with a lot of options out of the box. If you wish to contribute to the docs style / setup, or static site generation, you should consult the theme docs as a first step.

Running the docs locally

To run or build the docs locally, you need to first install the required dependencies:

pdm install -G:docs

Then you can serve the documentation with make docs-serve, or build them with make docs

Writing and editing docs

We welcome contributions that enhance / improve the content of the docs. Feel free to add examples, clarify text, restructure the docs, etc., but make sure to follow these guidelines:

  • Write text in idiomatic english, using simple language
  • Opt for Oxford commas when listing a series of terms
  • Keep examples simple and self contained
  • Provide links where applicable
  • Use intersphinx wherever possible when referencing external libraries
  • Provide diagrams using mermaidjs where applicable and possible

Adding examples

The examples from the docs are located in their own modules inside the /docs/examples folder. This makes it easier to test them alongside the rest of the test suite, ensuring they do not become stale as Litestar evolves.

Please follow the next guidelines when adding a new example:

  • Add the example in the corresponding module directory in /docs/examples or create a new one if necessary
  • Create a suite for the module in /docs/examples/tests that tests the aspects of the example that it demonstrates
  • Reference the example in the rst file with an external reference code block, e.g.
.. literalinclude:: /examples/test_thing.py
  :caption: test_thing.py
  :language: python

Automatically execute examples

Our docs include a Sphinx extension that can automatically run requests against example apps and include their result in the documentation page when its being built. This only requires 2 steps:

  1. Create an example file with an app object in it, which is an instance of Litestar
  2. Add a comment in the form of # run: /hello to the example file

When building the docs (or serving them locally), a process serving the app instance will be launched, and the requests specified in the comments will be run against it. The comments will be stripped from the result, and the output of the curl invocation inserted after the example code-block.

The # run: syntax is nothing special; Everything after the colon will be passed to the curl command that's being invoked. The URL is built automatically, so the specified path can just be a path relative to the app.

In practice, this looks like the following:

from typing import Dict

from litestar import Litestar, get


@get("/")
def hello_world() -> Dict[str, str]:
    """Handler function that returns a greeting dictionary."""
    return {"hello": "world"}


app = Litestar(route_handlers=[hello_world])

# run: /

This is equivalent to:

Creating a new release

  1. Increment the version in pyproject.toml according to the versioning scheme

    Note

    The version should follow semantic versioning and PEP 440.

2. Commit and push. 2. Draft a new release on GitHub

  • Use vMAJOR.MINOR.PATCH (e.g. v1.2.3) as both the tag and release title
  • Fill in the release description. You can use the "Generate release notes" function to get a draft for this
  1. Commit your changes and push to main
  2. Publish the release
  3. Go to Actions and approve the release workflow
  4. Check that the workflow runs successfully