Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
99 lines (65 loc) · 3.7 KB

CONTRIBUTING.md

File metadata and controls

99 lines (65 loc) · 3.7 KB
Raw

Contribution guide

⚙️ Setting up the environment

This project uses mise to manage tasks used for building and testing.

  1. Install mise

    • Install mise globally

      See here

    • Installing mise locally

      If you don't want to install mise globally, you can perform a local install using the provided bootstrap script.

      1. Run ./tools/mise to download and install mise in the .mise folder
      2. (optional) Activate mise in your shell

  2. Run mise run install to install all dependencies and pre-commit hooks

  3. See tasks documentation for more details

🤝 Code contributions

  1. Fork the strawchemy repository
  2. Clone your fork locally with git
  3. Set up the environment
  4. Make your changes
  5. Run mise run lint to run linters and formatters. This step is optional and will be executed automatically by git before you make a commit, but you may want to run it manually in order to apply fixes automatically by git before you make a commit, but you may want to run it manually in order to apply fixes
  6. Commit your changes to git
  7. Push the changes to your fork
  8. Open a pull request. Give the pull request a descriptive title indicating what it changes. If it has a corresponding open issue, the issue number should be included in the title as well. For example a pull request that fixes issue bug: Increased stack size making it impossible to find needle #100 could be titled fix(#100): Make needles easier to find by applying fire to

💡 Tip

Pull requests and commits all need to follow the Conventional Commit format

Conventional Commits

We enforce conventional commit messages using the conventional-commit pre-commit hook. This format is essential for maintaining consistent commit history and supports the automated release process (see below for details).

Your commit messages should follow this format:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Examples of valid commit messages:

  • feat: add new graph analysis method
  • fix: resolve memory leak in solver backend
  • docs: update installation instructions
  • test: add unit tests for network import

Common types: feat, fix, docs, style, refactor, test, chore

How It Works

When you commit changes, the pre-commit hooks will:

  1. Check your code with ruff for style errors and automatically fix what it can
  2. Validate your commit message format using conventional commits
  3. Run additional checks like trailing whitespace removal and large file detection
  4. Verify uv configuration and lock file consistency

If any hook finds errors that cannot be automatically fixed, the commit will be blocked until these errors are resolved. This helps maintain code quality and consistency across contributions.

Creating a new release

Using the GitHub workflow

  1. Run the bump workflow to bump the version and create a tag.

    Note: You can use the auto input when running the action to let cocogitto figure out the next version number. You can also choose one of major, minor or patch.

  2. Go to Actions and approve the release workflow

    Check that the release and then the publish workflows run successfully

Using the mise task

  1. Run mise run auto-bump to automatically bump the version
  2. Push your changes