Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add a section to HACKING.md on PR titles (commit messages to main) #1252

Merged
merged 3 commits into from
Jun 14, 2024
Merged

docs: add a section to HACKING.md on PR titles (commit messages to main) #1252

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
06847ea
Add a section on PR commit messages.
tonyandrewmeyer Jun 7, 2024
9b562db
This is markdown not rest, no need for ::.
tonyandrewmeyer Jun 7, 2024
9065fb0
Adjust wording as per review.
tonyandrewmeyer Jun 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions HACKING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,36 @@ your charm to a controller using that version of Juju. For example, with microk8
We rely on automation to [update charm pins](.github/actions/update-charm-pins/) of
a bunch of charms that use the operator framework. The script can be run locally too.

# Contributing

Changes are proposed as [pull requests on GitHub](https://github.com/canonical/operator/pulls).

Pull requests should have a short title that follows the
[conventional commit style](https://www.conventionalcommits.org/en/) using one of these types:

* chore
* ci
* docs
tonyandrewmeyer marked this conversation as resolved.
Show resolved Hide resolved
* feat
* fix
* perf
* refactor
tonyandrewmeyer marked this conversation as resolved.
Show resolved Hide resolved
* revert
* test

If the PR is limited to changes in ops.testing (Harness), also include the scope
`(harness)` in the title. At present, we do not add a scope in any other cases.

For example:

* feat: add the ability to observe change-updated events
* fix!: correct the type hinting for config data
* docs(harness): clarify the types of exceptions that Harness.add_user_secret may raise

Note that the commit messages to the PR's branch do not need to follow the
conventional commit format, as these will be squashed into a single commit to `main`
using the PR title as the commit message.

# Documentation

In general, new functionality
Expand Down
Loading