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/ondrolexa/apsg/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” is open to whoever wants to implement it.

Implement Features#

Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.

Write Documentation#

APSG could always use more documentation, whether as part of the official APSG 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/ondrolexa/apsg/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 apsg for local development.

  1. Fork the apsg repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:YOURUSER/apsg.git

  3. Install APSG with its dev dependencies using uv:

    $ uv sync --all-extras --dev

  4. Install pre-commit hooks to run linters and tests automatically:

    $ pre-commit install

  5. Create a branch for local development:

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

  6. Make your changes locally.

  7. Run tests and check code style:

    # Run tests
$ pytest

# Run linters via pre-commit
$ pre-commit run --all-files

# Build the documentation
$ cd docs
$ rm -rf _build
$ python -m sphinx -b html . _build

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

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

  9. 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.md.

  3. The pull request should work for Python 3.12 or later.