Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
100 lines (67 loc) · 3.29 KB

CONTRIBUTING.md

File metadata and controls

100 lines (67 loc) · 3.29 KB
Raw

Contributing

We are pleased that you would like to contribute to Steerability. We welcome both reporting issues and submitting pull requests.

Reporting issues

Please make sure to include any potentially useful information in the issue, so we can pinpoint the issue faster without going back and forth.

  • What SHA of Steerability are you running? If this is not the latest SHA on the main branch, please try if the problem persists with the latest version.
  • Python versions

Contributing a change

Contributions to this project are released to the public under the project's opensource license.

Contributors must sign off that they adhere to these requirements by adding a Signed-off-by line to all commit messages with an email address that matches the commit author:

feat: this is my commit message

Signed-off-by: Random J Developer <random@developer.example.org>

Development setup

Install the toolkit with the all extra and the default dev dependency group (pytest, pre-commit, and notebook tooling): uv sync --extra all

Coding style guidelines

We use tools to enforce code style:

  • isort, to sort imports (configured in [tool.isort] in pyproject.toml)
  • detect-secrets, to scan for credentials
  • a set of file checks, covering trailing whitespace, end-of-file newlines, large files, and YAML/TOML syntax

We run a series of checks on the codebase on every commit using pre-commit. To install the hooks, run: pre-commit install

To run the checks on-demand, run: pre-commit run --all-files

Contributing to documentation

uv sync --extra all --group docs

We use MkDocs to write documentation.

To run the documentation server, run:

uv run mkdocs serve

The server will be available at http://localhost:8000.

Pushing Documentation to GitHub Pages

Run the following:

uv run mkdocs gh-deploy

Submitting a pull request

  1. Fork and clone the repository
  2. Create a new branch: git checkout -b my-branch-name
  3. Make your change, push to your fork and submit a pull request
  4. Wait for your pull request to be reviewed and merged.

Developer info

We are pleased that you are developing new functionality for the toolkit. Before committing any code, please make sure you run the secret scanning below.

Secret scanning

This repository uses IBM's detect-secrets to scan for secrets before the code is pushed to GitHub. Follow installation instructions in their repository: https://github.com/ibm/detect-secrets?tab=readme-ov-file#example-usage

To update the secrets database manually, run:

detect-secrets scan --update .secrets.baseline

To audit detected secrets, use:

detect-secrets audit .secrets.baseline

If the pre-commit hook raises an error but the audit command succeeds with just Nothing to audit! then run detect-secrets scan --update .secrets.baseline to perform a full scan and then repeat the audit command.