Skip to content

CONTRIBUTING.rst

Latest commit

 

History

History
223 lines (144 loc) · 6.6 KB

CONTRIBUTING.rst

File metadata and controls

223 lines (144 loc) · 6.6 KB

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/multiformats/py-multicodec/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.

Write Documentation

py-multicodec could always use more documentation, whether as part of the official py-multicodec docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/multiformats/py-multicodec/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here's how to set up multicodec for local development.

  1. Fork the py-multicodec repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/py-multicodec.git

  3. Install your local copy into a virtualenv. Create and activate a virtual environment:

    $ python -m venv venv
$ source venv/bin/activate  # On Windows: venv\Scripts\activate
$ pip install -e ".[dev]"

  4. Install pre-commit hooks (optional but recommended):

    $ pre-commit install

    This will set up git hooks to automatically run linting and formatting checks before each commit.

  5. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  6. When you're done making changes, check that your changes pass linting and the tests, including testing other Python versions with tox:

    $ make lint
$ make test
$ tox

    Or run pre-commit manually on all files:

    $ pre-commit run --all-files

    If you installed pre-commit hooks (step 4), they will run automatically on commit.

Development Workflow Commands

The project provides several make targets to help with development:

  • make fix - Automatically fix formatting and linting issues using ruff. Use this when you want to auto-fix code style issues.
  • make lint - Run all pre-commit hooks on all files to check for code quality issues. This includes YAML/TOML validation, trailing whitespace checks, pyupgrade, ruff linting and formatting, and mypy type checking.
  • make typecheck - Run mypy type checking only. Use this when you want to quickly check for type errors without running all other checks.
  • make test - Run the test suite with pytest using the default Python version. For testing across multiple Python versions, use tox instead.
  • make pr - Run a complete pre-PR check: clean build artifacts, fix formatting, run linting, type checking, and tests. This is the recommended command to run before submitting a pull request.

For a full list of available commands, run make help.

  1. Commit your changes and push your branch to GitHub:

    $ git add .
$ git commit -m "Your detailed description of your changes."
$ git push -u origin name-of-your-bugfix-or-feature

  2. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
  3. The pull request should work for Python 3.10, 3.11, 3.12, 3.13, and 3.14. Check https://github.com/multiformats/py-multicodec/actions and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ pytest tests/test_multicodec.py

Releasing

Releases are typically done from the master branch, except when releasing a beta (in which case the beta is released from master, and the previous stable branch is released from said branch).

Final test before each release

Before releasing a new version, build and test the package that will be released:

git checkout master && git pull
make package-test

This will build the package and install it in a temporary virtual environment. Follow the instructions to activate the venv and test whatever you think is important.

You can also preview the release notes:

towncrier --draft

Build the release notes

Before bumping the version number, build the release notes. You must include the part of the version to bump (see below), which changes how the version number will show in the release notes.

make notes bump=$$VERSION_PART_TO_BUMP$$

If there are any errors, be sure to re-run make notes until it works.

Push the release to github & pypi

After confirming that the release package looks okay, release a new version:

make release bump=$$VERSION_PART_TO_BUMP$$

This command will:

  • Bump the version number as specified wherever it appears in the repo.
  • Create a git commit and tag for the new version.
  • Build the package.
  • Push the commit and tag to github.
  • Push the new package files to pypi.

Which version part to bump

$$VERSION_PART_TO_BUMP$$ must be one of: major, minor, patch, stage, or devnum.

The version format for this repo is {major}.{minor}.{patch} for stable, and {major}.{minor}.{patch}-{stage}.{devnum} for unstable (stage can be alpha or beta).

If you are in a beta version, make release bump=stage will switch to a stable.

To issue an unstable version when the current version is stable, specify the new version explicitly, like make release bump="--new-version 4.0.0-alpha.1"

You can see what the result of bumping any particular version part would be with bump-my-version show-bump