First off, thank you for taking the time to contribute to Minder! 👍 🎉 Minder is released under the Apache 2.0 license. If you would like to contribute something or want to hack on the code, this document should help you get started. You can find some hints for starting development in Minder's README.
This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to code-of-conduct@stacklok.dev.
If you think you have found a security vulnerability in Minder please DO NOT disclose it publicly until we’ve had a chance to fix it. Please don’t report security vulnerabilities using GitHub issues; instead, please follow this process
We use GitHub issues to track bugs and enhancements. If you have a general usage question, please ask in Minder's discussion forum.
If you are reporting a bug, please help to speed up problem diagnosis by providing as much information as possible. Ideally, that would include a small sample project that reproduces the problem.
Before we accept a non-trivial patch or pull request, we will need you to sign the Contributor License Agreement. Signing the contributor’s agreement does not grant anyone commit rights to the main repository, but it does mean that we can accept your contributions, and you will get an author credit if we do. Active contributors might be asked to join the core team and given the ability to merge pull requests.
PRs to resolve existing issues are greatly appreciated and issues labeled as "good first issue" are a great place to start!
- Create an issue outlining the fix or feature.
- Fork the Minder repository to your own GitHub account and clone it locally.
- Hack on your changes.
- Correctly format your commit messages, see Commit Message Guidelines below.
- Open a PR by ensuring the title and its description reflect the content of the PR.
- Ensure that CI passes, if it fails, fix the failures.
- Every pull request requires a review from the core Minder team before merging.
- Once approved, all of your commits will be squashed into a single commit with your PR title.
Follow this guide for instructions on building, running, and previewing Minder's documentation.
We follow the commit formatting recommendations found on Chris Beams' How to Write a Git Commit Message article:
- Separate subject from body with a blank line
- Limit the subject line to 50 characters
- Capitalize the subject line
- Do not end the subject line with a period
- Use the imperative mood in the subject line
- Use the body to explain what and why vs. how