CONTRIBUTING.md

Contribution Guidelines

We would appreciate your contributions:

• Feature requests and bug reports
• Security vulnerability reports
• Pull requests

Pull requests

If the change proposed is not trivial, like typo in docs, please create an issue first.

Prerequisites

You will need:

• uv
• Just
• GNU make
• Docker
• Git

Initialize dev environment

• Fork project repository makukha/pydantic-file-secrets under your account.

• Create feature branch in your fork.

• Clone and install Python packages:

  git clone https://github.com/<YOUR_USER_NAME>/pydantic-file-secrets.git
  just sync

Write code

It is convenient to start from adding tests reproducing the bug or shaping the new feature. All added code must be covered with tests.

The code will be checked with Ruff and mypy. See pyproject.toml for details.

Run lint and format checks

just lint

There must be no errors.

Run tests

• Fast, the "main" configuration only:

  just test -m main

  Coverage report is generated as part of "main" configuration. Every new PR must not decrease the code coverage.

• The whole test matrix (will take some time):

  just test

• Debug single failing tox environment other than "main":

  just test -e <TOX ENV NAME>

  See tox.ini for details.

Build docs

just docs

There must be no errors.

Add future changelog entry

just news

Edit the new *.md file added under NEWS.d/: uncomment the appropriate section and describe what was done in your pull request.

Create pull request

The project maintainers will get back to review your PR.

Thank you for your valuable contribution!