Contributing¶
Contributions are welcome, and they are greatly appreciated! Every little helps, and credit will always be given. You can contribute in many ways.
Types of Contributions¶
Report Bugs¶
Report bugs at https://github.com/gabor-boros/minutes/issues.
If you are reporting a bug, please use the bug report template, and 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 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. In case you added a new source or target, do not forget to add them to the docs as well.
Write Documentation¶
Minutes could always use more documentation, whether as part of the 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.
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 minutes for local development.
As step 0 make sure you have mise installed.
- Fork the repository
- Clone your fork locally
$ git clone git@github.com:your_name_here/minutes.git
- Install tools and hooks
$ cd minutes
$ mise trust
$ mise install
$ mise run pre-commit
$ mise run docs:deps
- Create a branch for local development
$ git checkout -b github-username/bugfix-or-feature-name
- When you're done making changes, check that your changes are formatted, passing linters, and tests are succeeding
$ mise run format
$ mise run lint
$ mise run test
- Update documentation and check the results by running
mise run docs - Commit your changes and push your branch to GitHub
We use conventional commits. Commit messages are checked by commitlint via the commit-msg hook.
$ git add .
$ git commit -m "feat(scope): summary"
$ git push origin github-username/bugfix-or-feature-name
- Submit a pull request on GitHub
Pull Request Guidelines¶
Before you submit a pull request, check that it meets these guidelines:
- The pull request should include tests
- Tests should pass for the PR
- If the pull request adds new functionality, or changes existing one, the docs should be updated
Releasing¶
A reminder for the maintainers on how to release.
Releases are driven by Release Please. Conventional commits on main open or update a release PR that bumps [workspace.package].version in the root Cargo.toml (member crates inherit via version.workspace = true) and updates CHANGELOG.md. The config uses release-type: simple because the rust strategy cannot rewrite inherited member versions.
- Make sure every required PR is merged
- Make sure CI is green on
main - Wait for (or trigger) the Release Please PR
- Review the changelog and version bump, then merge the Release Please PR
- Merging creates the GitHub Release/tag; the release workflow builds multi-platform binaries, uploads them to the release, and updates the Homebrew formula in
gabor-boros/homebrew-brew
Maintainer secrets¶
Configure these repository secrets for CI:
HOMEBREW_TAP_TOKEN— token with write access togabor-boros/homebrew-brew- Optionally a PAT for Release Please if the default
GITHUB_TOKENcannot open release PRs