Skip to content

Latest commit

 

History

History
61 lines (36 loc) · 3.03 KB

CONTRIBUTING.md

File metadata and controls

61 lines (36 loc) · 3.03 KB
Raw

Contributing guide

We welcome new users and contributors to this project. This document contains the guidelines for contributing to these code repositories.

How to contribute

Getting help

Please create an issue or contact Mike Smith.

Version control

Please create branches and request for them to be merged using pull requests.

Proposing changes

Feel free to fork these repositories to propose new changes.

Releases

See: Releasing projects on GitHub

Publishing a new release

  1. Incrememnt the version number in the code repository by editing the value of the __version__ variable in __init__.py
  2. Create a new release
  3. Click "Choose a tag" and enter the version number
  4. TODO

The Python package will be automatically published to PyPI using a GitHub Actions workflow.

Version numbers

The PEP 440 standard means that each release has a version number such as v1.4.2 where the three parts are MAJOR.MINOR.PATCH where

  • MAJOR version when you make incompatible API changes
  • MINOR version when you add functionality in a backward compatible manner
  • PATCH version when you make backward compatible bug fixes

When working on changes, you can make a development release such as v0.3.dev2.

Packaging

Each code repository contains a Python package that is specified using a pyproject.toml file. These packages are published to the Python Package Index (PyPI) so they can be easily installed by anyone.

Coding style conventions

See: PEP 8 – Style Guide for Python Code.

Documentation strings

Documentation strings (PEP 257) describe how a function works. One style is Epytext:

def my_function(aardvark_count: float):
  """
  This is my code.

  @param aardvark_count: The number of Aardvarks.
  """