Contributing

Reporting Bugs & Proposing Changes

Use the GitHub Issues page:

1. Go to https://github.com/pushfoo/python-better-sum/issues
2. Search for existing closed and open issues
3. If none seem relevant, file a new one!

Contributor Setup

Before you contribute code, you'll need to get your development environment set up.

After making sure you have Python 3.9+:

1. Fork and locally clone the repo
2. Create and activate a virtual environment
3. venv is the default
4. others probably work too
5. pip install --upgrade pip
6. pip install -I -e .[dev]
7. For users Python's standard venv tool:
8. deactivate the virtual environment
9. reactivate it as described in the venv doc

Per the comments on reactivation seems to be necessary on the default venv. Poetry and Rye are unaffected. To learn more, please see:

• This comment on mkdocstrings issue #215
• The other comments in the same thread

Making Changes

Code Changes

The project aims to be simple.

• Remove items from the project's pyproject.toml dependencies section
• Don't add them without a very compelling reason

Documentation

Documentation dependencies can be added if needed to make the doc better.

At the moment, this project uses:

• mkdocs
• mkdocstrings

This means we aren't using the original Markdown from 2004. Instead, we the following dialects:

Markdown Flavor	Where it's used
Python-Markdown	Docstrings and everything in the repo's docs folder
GitHub-flavored Markdown	Only top-level files in the GitHub repo ([README.md], etc)