Skip to content

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/climateimpactlab/isku/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 a fix for 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

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

PRs with small corrections to spelling, format or clarity are welcome. The project has designed its documentation to make this process easier for non-technical users to contribute to documentation.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/climateimpactlab/isku/issues.

If you are proposing a new 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 isku for local development. Please note this documentation assumes you already have uv, just, and git installed and ready to go.

  1. Fork the isku repo on GitHub.

  2. Clone your fork locally:

cd <directory_in_which_repo_should_be_created>
git clone git@github.com:YOUR_NAME/isku.git
  1. Now we need to install the environment. Navigate into the directory
cd isku

Then, install and activate the environment with:

uv sync
  1. Install prek to run linters/formatters at commit time:
uv run prek install --prepare-hooks
  1. Create a branch for local development:
git checkout -b name-of-your-bugfix-or-feature

Now you can make your changes locally.

  1. Don't forget to add test cases for your added functionality to the tests directory.

  2. When you're done making changes, check that your changes pass the lint tests.

just lint

Now, validate that automated tests are passing:

just test
  1. 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
  1. Submit a pull request through the GitHub website.

Documentation

Documentation is in the docs/ directory with global configurations in the .zensical file. Documentation is rendered with Zensical and hosted through GitHub Pages to https://climateimpactlab.github.io/isku/.

You can build and check any changes or additions you've made to documentation locally on your machine after you've set up your development environment.

Make a clean, validated build of the documentation with

just build-docs

You can build and serve the documentation pages locally with

just serve-docs

and then view your changes in a web browser by following the on-screen URL.

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.