Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
256 lines (161 loc) · 9.65 KB

CONTRIBUTING.md

File metadata and controls

256 lines (161 loc) · 9.65 KB

How To Contribute

Important

  • This document is mainly to help you to get started by codifying tribal knowledge and expectations and make it more accessible to everyone. But don't be afraid to open half-finished PRs and ask questions if something is unclear!

  • If you use LLM / "AI" tools for your contributions, please read and follow our Generative AI / LLM Policy.

Support

In case you'd like to help out but don't want to deal with GitHub, there's a great opportunity: help your fellow developers on Stack Overflow!

The official tag is structlog and helping out in support frees us up to improve structlog instead!

Workflow

First off, thank you for considering to contribute! It's people like you who make this project such a great tool for everyone.

  • No contribution is too small! Please submit as many fixes for typos and grammar bloopers as you can!

  • Only contribute code that you fully understand. See also our AI policy.

  • Very relatedly, our pull request check list is our mandatory Van Halen test. Sadly, the current state of the world has forced us into being stricter about policies -- sorry fellow humans!

  • Try to limit each pull request to one change only (except for typos -- please group those).

  • Since we squash on merge, it's up to you how you handle updates to the main branch. Whether you prefer to rebase on main or merge main into your branch, do whatever is more comfortable for you.

    Just remember to not use your own main branch for the pull request.

  • Always add tests and docs for your code. This is a hard rule; patches with missing tests or documentation won't be merged.

  • Consider updating CHANGELOG.md to reflect the changes as observed by people using this library.

  • Make sure your changes pass our CI. You won't get any feedback until it's green unless you ask for it.

    For the CI to pass, the coverage must be 100%. If you have problems to test something, open anyway and ask for advice. In some situations, we may agree to add an # pragma: no cover.

  • Once you've addressed review feedback, make sure to bump the pull request with a short note, so we know you're done.

  • Don't break backwards-compatibility.

Local development environment

First, fork the repository on GitHub. Make sure to uncheck the Copy the main branch only radio button on the Create a new fork page. If you don't, our test suite will fail because we use Git tags for packaging.

Finally, clone it using one of the alternatives that you can copy-paste by pressing the big green button labeled <> Code.

You can (and should) run our test suite using tox (and keep in mind that tox run-parallel is about 5x faster than tox run). However, you'll probably want a more traditional environment as well.

We recommend using the Python version from the .python-version-default file in the project's root directory, because that's the one that is used in the CI by default, too.

If you're using direnv, you can automate the creation of the project virtual environment with the correct Python version by adding the following .envrc to the project root:

layout python python$(cat .python-version-default)

or, if you like uv:

test -d .venv || (uv venv --python $(cat .python-version-default) && uv pip install -e . --group dev)
. .venv/bin/activate

Warning

  • Before you start working on a new pull request, use the "Sync fork" button in GitHub's web UI to ensure your fork is up to date.
  • Always create a new branch off main for each new pull request. Yes, you can work on main in your fork and submit pull requests. But this will inevitably lead to you not being able to synchronize your fork with upstream and having to start over.

Change into the newly created directory and after activating a virtual environment, install an editable version of this project along with its tests requirements:

$ pip install -e . --group dev  # or `uv pip install -e . --group dev`

Now you can run the test suite:

$ python -Im pytest

When working on the documentation, use:

$ tox run -e docs-watch

This will build the documentation, watch for changes, and rebuild it whenever you save a file.

To just build the documentation and exit immediately use:

$ tox run -e docs-build

You will find the built documentation in docs/_build/html.

To run doctests:

$ tox run -e docs-doctests

Code

  • Obey PEP 8 and PEP 257. We use the """-on-separate-lines style for docstrings with Napoleon-style API documentation:

    def func(x: str, y: int) -> str:
    """
    Do something.

    Args:
        x: A very important argument.

        y:
          Another very important argument, but its description is so long
          that it doesn't fit on one line. So, we start the whole block on a
          fresh new line to keep the block together.

    Returns:
        The result of doing something.
    """

    Please note that the API docstrings are still reStructuredText.

  • If you add or change public APIs, tag the docstring using .. versionadded:: 24.1.0 WHAT or .. versionchanged:: 24.1.0 WHAT. We follow CalVer, so the next version will be the current with with the middle number incremented (for example, 24.1.0 -> 24.2.0).

  • We use Ruff to sort our imports and format our code with a line length of 79 characters. As long as you run our full tox suite before committing, or install our pre-commit hooks (ideally you'll do both -- see Local Development Environment above), you won't have to spend any time on formatting your code at all. If you don't, CI will catch it for you -- but that seems like a waste of your time!

Tests

  • Write your asserts as expected == actual to line them up nicely, and leave an empty line before them:

    x = f()

assert 42 == x.some_attribute
assert "foo" == x._a_private_attribute

  • You can run the test suite runs with all (optional) dependencies against all supported Python versions -- just as it will in our CI -- by running tox.

  • Write good test docstrings.

Documentation

  • Use semantic newlines in reStructuredText (*.rst) and Markdown (*.md) files:

    This is a sentence.
This is another sentence.

This is a new paragraph.

  • If you start a new section, add two blank lines before and one blank line after the header except if two headers follow immediately after each other:

    # Main Header

Last line of previous section.


## Header of New Top Section

### Header of New Section

First line of new section.

Changelog

If your change is interesting to end-users, there needs to be an entry in our CHANGELOG.md, so they can learn about it.

  • The changelog follows the Keep a Changelog standard. Add the best-fitting section if it's missing for the current release. We use the following order: Security, Removed, Deprecated, Added, Changed, Fixed.

  • As with other docs, please use semantic newlines in the changelog.

  • Make the last line a link to your pull request. You probably have to open it first to know the number.

  • Leave an empty line between entries, so it doesn't look like a wall of text.

  • Refer to all symbols by their fully-qualified names. For example, structlog.Foo -- not just Foo.

  • Wrap symbols like modules, functions, or classes into backticks, so they are rendered in a monospace font.

  • Wrap arguments into asterisks so they are italicized like in API documentation: Added new argument *an_argument*.

  • If you mention functions or methods, add parentheses at the end of their names: structlog.func() or structlog.Class.method(). This makes the changelog a lot more readable.

  • Prefer simple past tense or constructions with "now". In the Added section, you can leave out the "Added" prefix:

    ### Added

- `structlog.func()` that does foo.
  It's pretty cool.
  [#1](https://github.com/hynek/structlog/pull/1)


### Fixed

- `structlog.func()` now doesn't crash the Large Hadron Collider anymore.
  That was a nasty bug!
  [#2](https://github.com/hynek/structlog/pull/2)

See you on GitHub!

Again, this whole file is mainly to help you to get started by codifying tribal knowledge and expectations to save you time and turnarounds. It is not meant to be a barrier to entry, so don't be afraid to open half-finished PRs and ask questions if something is unclear!

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. Please report any harm to Hynek Schlawack in any way you find appropriate.