Skip to content

Latest commit

 

History

History
163 lines (116 loc) · 4.98 KB

CONTRIBUTING.md

File metadata and controls

163 lines (116 loc) · 4.98 KB
Raw

Contributing to B2 Command Line Tool

We encourage outside contributors to perform changes to our codebase. Many such changes have been merged already. In order to make it easier to contribute, core developers of this project:

  • provide guidance (through the issue reporting system)
  • provide tool assisted code review (through the Pull Request system)
  • maintain a set of unit tests
  • maintain a set of integration tests (run with a production cloud)
  • maintain development automation tools using nox that can easily:
    • format the code using yapf and ruff
    • run linters to find subtle/potential issues with maintainability
    • run the test suite on multiple Python versions using pytest
  • maintain Continuous Integration (by using GitHub Actions) that:
    • runs all sorts of linters
    • checks if the Python distribution can be built
    • runs all tests on a matrix of supported versions of Python (including PyPy) and 3 operating systems (Linux, Mac OS X, and Windows)
    • checks if the documentation can be built properly
  • maintain other Continuous Integration tools (coverage tracker)

Versioning

This package's versions adheres to Semantic Versioning and the versions are established by reading git tags, i.e. no code or manifest file changes are required when working on PRs.

Changelog

Each PR needs to have at least one changelog (aka news) item added. This is done by creating files in changelog.d. towncrier is used for compiling these files into CHANGELOG.md. There are several types of changes (news):

  1. fixed
  2. changed
  3. added
  4. deprecated
  5. removed
  6. infrastructure
  7. doc

The changelog.d file name convention is:

  1. If the PR closes a github issue: {issue_number}.{type}.md e.g. 157.fixed.md. Note that the change description still has to be complete, linking an issue is just there for convenience, a change like fixed #157 will not be accepted.
  2. If the PR is not related to a github issue: +{unique_string}.{type}.md e.g. +foobar.fixed.md.

These files can either be created manually, or using towncrier e.g.

towncrier create -c 'Add proper changelog example to CONTRIBUTING guide' 157.added.md

towncrier create also takes care of duplicates automatically (if there is more than 1 news fragment of one type for a given github issue).

Developer Info

You'll need to have nox and pdm installed:

  • pip install nox pdm

With nox, you can run different sessions (default are lint and test):

  • format -> Format the code.
  • lint -> Run linters.
  • test (test-3.8, test-3.9, test-3.10, test-3.11) -> Run test suite.
  • cover -> Perform coverage analysis.
  • build -> Build the distribution.
  • generate_dockerfile -> generate dockerfile
  • docker_test -> run integration tests against a docker image
  • build_and_test_docker -> build a docker image and integration tests against it
  • doc -> Build the documentation.
  • doc_cover -> Perform coverage analysis for the documentation.

For example:

$ nox -s format
nox > Running session format
nox > Creating virtual environment (virtualenv) using python3.11 in .nox/format
...

$ nox -s format
nox > Running session format
nox > Re-using existing virtual environment at .nox/format.
...

$ nox --no-venv -s format
nox > Running session format
...

Sessions test ,unit, and integration can run on many Python versions.

Sessions other than that use the last given Python version.

You can change it:

export NOX_PYTHONS=3.9,3.10

With the above setting, session test will run on Python 3.9 and 3.10, and all other sessions on Python 3.10.

Given Python interpreters should be installed in the operating system or via pyenv.

Managing dependencies

We use pdm for managing dependencies and developing locally. If you want to change any of the project requirements (or requirement bounds) in pyproject.toml, make sure that pdm.lock file reflects those changes by using pdm add, pdm update or other commands - see documentation. You can verify that lock file is up to date by running the linter.

Linting

To run all available linters:

nox -s lint

Testing

To run all tests on every available Python version:

nox -s test

To run all tests on a specific version:

nox -s test-3.11

To run just unit tests:

nox -s unit-3.11

To run just integration tests:

export B2_TEST_APPLICATION_KEY=your_app_key
export B2_TEST_APPLICATION_KEY_ID=your_app_key_id
nox -s integration-3.11

Documentation

To build the documentation and watch for changes (including the source code):

nox -s doc

To just build the documentation:

nox --non-interactive -s doc