Skip to content
This repository has been archived by the owner on Jul 5, 2024. It is now read-only.

Latest commit

 

History

History
91 lines (57 loc) · 2.97 KB

CONTRIBUTING.md

File metadata and controls

91 lines (57 loc) · 2.97 KB
Raw

Contributing code

Please read the Code of Conduct, you can expect to be treated with respect at all times when interacting with this project.

Contributing Setup

Clone the project locally and simply run curl -sL https://raw.github.com/elgalu/ensure/main/setup.sh | bash

Then source .venv/bin/activate

If contributor_setup didn't work on your system you can do the setup manually, step by step:

  1. Clone the project locally
  2. Install the corresponding .python-version using something like pyenv
  3. Create a virtual environment named .venv with python -m venv .venv
  4. Activate the virtual environment with source .venv/bin/activate
  5. Install poetry
  6. Run poetry install --no-root (--no-root to install the dependencies only, not the project)
  7. Install invoke with pip install invoke
  8. Run invoke setup

Feature branches

This project uses towncrier for CHANGELOG automation. Start all your feature/bugs/other with:

Create a release branch

Make sure you're on a release branch, e.g. git checkout -b release-0.0.8 . And that the release branch is pushed (tracked) in origin, else you'll get does not track anything tbump error.

Create a new fragment for the CHANGELOG

# "initial_setup" is the name of the fragment
# "add" is the fragment type; add|changed|deprecated|removed|fixed|security
towncrier create "initial_setup.add"
#=> Created news fragment at .changelog.d/initial_setup.add

Then edit the initial_setup.add file describing what you're doing.

Running the tests locally

Run poetry run invoke tests

Running all checks (including tests)

Run poetry run invoke all

Maintainers

Creating a new version

Build the Changelog

Commit all your local changes. Add --yes when running in CI/CD to avoid stdin questions:

towncrier build --version "0.0.8" --draft  # test first
towncrier build --version "0.0.8"          # final

Now fix the CHANGELOG.md order and sub-headings.

Run invoke hooks then tbump "0.0.8"

Manual tbump Release

Bump with tbump "0.0.8" --only-patch

Commit changes with Release 0.0.8 with _

Then run poetry build && poetry publish to also publish to https://pypi.org/project/iometrics

Additional notes on tbump

If you want to bump the version locally, without creating a git tag use tbump "0.0.8" --only-patch

However the version bumping is currently automated in CI/CD via tbump "0.0.8" --non-interactive

Build and publish the new version to PyPI

You'll need a PyPi account to release manually, see https://pypi.org/project/iometrics

Feel free to build the package for local testing via poetry build however package publishing is currently automated in CI/CD via poetry publish