Thank you for your interest in contributing to Grafana
generate-policy-bot-config project! We welcome all people who want to
contribute in a healthy and constructive manner within our community. To help us
create a safe and positive community experience for all, we require all
participants to adhere to the Code of Conduct.
This document is a guide to help you through the process of contributing to
generate-policy-bot-config.
You can contribute to Grafana generate-policy-bot-config in several ways. Here
are some examples:
- Contribute to the codebase itself.
- Report bugs and enhancements.
- Help with maintaining the project, for example by responding to issues and creating releases.
For more ways to contribute, check out the Open Source Guides.
Report a bug by submitting a bug report. Make sure that you provide as much information as possible on how to reproduce the bug.
Before submitting a new issue, try to make sure someone hasn't already reported the problem. Look through the existing issues for similar issues.
If you believe you've found a security vulnerability, please read our security policy for more details.
We use release-please to create releases. This will maintain
a draft pull request with the changes needed to bump the version and update the
changelog, updated with the changes since the last release.
Releasing should be as simple as undrafting and merging that pull request, then double-checking the created release and publishing it. Check that a GitHub release, a tag, and the Docker releases were created.
As we're using release-please to create releases, we need to
use conventional commit messages. This means that each commit message should
follow the format:
<type>[optional scope]: <description>
See the conventional commits specification for more details.
A CI check is in place which will enforce this format.