Skip to content

CONTRIBUTING.rst

Latest commit

 

History

History
364 lines (223 loc) · 8.79 KB

CONTRIBUTING.rst

File metadata and controls

364 lines (223 loc) · 8.79 KB
Raw

Contributing Guide

Welcome! There are many ways to contribute, including submitting bug reports, improving documentation, submitting feature requests, reviewing new submissions, or contributing code that can be incorporated into the project.

Review process

For any significant changes please create a new GitHub issue and enhancements that you wish to make. Describe the feature you would like to see, why you need it, and how it will work. Discuss your ideas transparently and get community feedback before proceeding.

Small changes can directly be crafted and submitted to the GitHub Repository as a Pull Request. This requires creating a repo fork using instruction.

Initial setup for local development

Install Git

Please follow instruction.

Clone the repo

Open terminal and run these commands to clone a forked repo:

git clone git@github.com:myuser/data-rentgen.git -b develop

cd data-rentgen

Setup environment

Firstly, install make. It is used for running complex commands in local environment.

Secondly, create virtualenv and install dependencies:

make venv

If you already have venv, but need to install dependencies required for development:

make venv-install

We are using `uv https://docs.astral.sh/uv/`_ for managing dependencies and building the package. It allows to keep development environment the same for all developers due to using lock file with fixed dependency versions.

There are extra dependencies (included into package as optional):

  • server
  • consumer
  • http2kafka
  • postgres
  • gssapi
  • seed

And groups (not included into package, used locally and in CI):

  • test - for running tests
  • dev - for development, like linters, formatters, mypy, pre-commit and so on
  • mddocs - for building documentation

Enable pre-commit hooks

pre-commit hooks allows to validate & fix repository content before making new commit. It allows to run linters, formatters, fix file permissions and so on. If something is wrong, changes cannot be committed.

Firstly, install prek:

prek install --install-hooks

Ant then test hooks run:

prek run

How to

Run development instance locally

Start DB container & seed database with some examples:

make db db-seed

Then start development server:

make dev-server

And open http://localhost:8000/docs

Settings are stored in config.yml.

To start developlment consumer, open a new terminal window/tab, and run:

make broker dev-consumer

Working with migrations

Start database:

make db-start

Generate revision:

make db-revision ARGS="-m 'Message'"

Upgrade db to head migration:

make db-upgrade

Downgrade db to head-1 migration:

make db-downgrade

Run tests locally

This is as simple as:

make test

This command starts all necessary containers (Postgres, Kafka), runs all necessary migrations, and then runs Pytest.

You can pass additional arguments to pytest like this:

make test PYTEST_ARGS="-m client-sync -lsx -vvvv --log-cli-level=INFO"

Stop all containers and remove created volumes:

make test-cleanup ARGS="-v"

Get fixtures not used by any test:

make test-check-fixtures

Run production instance locally

Firstly, build production image:

make prod-build

And then start it:

make prod

Then open http://localhost:8000/docs

Settings are stored in config.docker.yml.

Build documentation

Build documentation using MkDocs & open it:

make docs

If documentation should be build cleanly instead of reusing existing build result:

make docs-fresh

Create pull request

Commit your changes:

git commit -m "Commit message"
git push

Then open Github interface and create pull request. Please follow guide from PR body template.

After pull request is created, it get a corresponding number, e.g. 123 (pr_number).

Write release notes

Data.Rentgen uses towncrier for changelog management.

To submit a change note about your PR, add a text file into the mddocs/docs/changelog/next_release folder. It should contain an explanation of what applying this PR will change in the way end-users interact with the project. One sentence is usually enough but feel free to add as many details as you feel necessary for the users to understand what it means.

Use the past tense for the text in your fragment because, combined with others, it will be a part of the "news digest" telling the readers what changed in a specific version of the library since the previous version.

You should also use Markdown syntax for highlighting code (inline or block), linking parts of the docs or external sites.

Finally, name your file following the convention that Towncrier understands: it should start with the number of an issue or a PR followed by a dot, then add a patch type, like feature, doc, misc etc., and add .md as a suffix. If you need to add more than one fragment, you may add an optional sequence number (delimited with another period) between the type and the suffix.

In general the name will follow <pr_number>.<category>.md pattern, where the categories are:

  • feature: Any new feature. Adding new functionality that has not yet existed.
  • removal: Signifying a deprecation or removal of public API.
  • bugfix: A bug fix.
  • improvement: An improvement. Improving functionality that already existed.
  • doc: A change to the documentation.
  • dependency: Indicates that there have been changes in dependencies.
  • misc: Changes internal to the repo like CI, test and build changes.
  • breaking: introduces a breaking API change.
  • significant: Indicates that significant changes have been made to the code.

A pull request may have more than one of these components, for example a code change may introduce a new feature that deprecates an old feature, in which case two fragments should be added. It is not necessary to make a separate documentation fragment for documentation changes accompanying the relevant code changes.

Examples for adding changelog entries to your Pull Requests

Fixed behavior of `server`
Added support of `timeout` in `LDAP`

Tip

See pyproject.toml for all available categories (tool.towncrier.type).

How to skip change notes check?

Just add ci:skip-changelog label to pull request.

Release Process

Note

This is for repo maintainers only

Before making a release from the develop branch, follow these steps:

  1. Checkout to develop branch and update it to the actual state
git checkout develop
git pull -p
  1. Get current release version
VERSION=$(cat data_rentgen/VERSION)
  1. Build changelog for current release
make docs-generate-changelog
  1. Commit and push changes to develop branch
git add .
git commit -m "Prepare for release ${VERSION}"
git push
  1. Merge develop branch to master, WITHOUT squashing
git checkout master
git pull
git merge develop
git push
  1. Add git tag to the latest commit in master branch
git tag "$VERSION"
git push origin "$VERSION"
  1. Update version in develop branch after release:
git checkout develop

NEXT_VERSION=$(echo "$VERSION" | awk -F. '/[0-9]+\./{$NF++;print}' OFS=.)
echo $NEXT_VERSION > data_rentgen/VERSION

git add .
git commit -m "Bump version"
git push