Skip to content

Commit

Permalink
DOCS(git): Add PR and merge commit guidance to commit guidelines
Browse files Browse the repository at this point in the history
Implements mumble-voip#6385

Our `scripts/generate_changelog.py` script `pr_number_pattern` already supports PR numbers in the form `(#<nr>)`.

The GitHub repository can be configured to merge with PR title + (#<nr>) + desc, which follows this form.

[1]: https://github.com/mumble-voip/mumble/blob/56f03e8d7e5f9cf9d1a318d3a1858db4e09c06ab/scripts/generate_changelog.py#L22-L24
  • Loading branch information
Kissaki committed Apr 10, 2024
1 parent 56f03e8 commit b041fa0
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions COMMIT_GUIDELINES.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,25 @@ FIX(client): Crash when loading settings
MAINT: Add XY to README
```

## Pull Requests and Merge Commits

Merge commits shall follow the same commit guidelines and format as "normal" commits.
They include a pull reqeust reference at the end.

For example:

```
FEAT(client): Add ReNameNoise as a replacement for RNNoise (#6364)
```

Pull requests, when accepted, ultimately become merge commits (merging the enclosed commits). Consequently:

**Pull requests should be created with a title and description following the commit guidelines and format.**

A pull request and merge commit encloses one or multiple commits.
Each commit has their own title and descriptions of changes.
The pull request and merge commit should title and describe the changeset overall in a summarizing manner.

-----

This guide was inspired by https://github.com/bluejava/git-commit-guide
Expand Down

0 comments on commit b041fa0

Please sign in to comment.