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(git): Add PR and merge commit guidance to commit guidelines #6391

Closed
wants to merge 2 commits into from
Closed

DOCS(git): Add PR and merge commit guidance to commit guidelines #6391

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b041fa0
DOCS(git): Add PR and merge commit guidance to commit guidelines
Kissaki Apr 10, 2024
7a21600
DOCS(github): Update PR template with form checkbox note
Kissaki Apr 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
1 change: 1 addition & 0 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@
### Checks

- [ ] My commits follow the [commit guidelines](https://github.com/mumble-voip/mumble/blob/master/COMMIT_GUIDELINES.md)
- [ ] My pull request title follows the [commit guidelines](https://github.com/mumble-voip/mumble/blob/master/COMMIT_GUIDELINES.md)

19 changes: 19 additions & 0 deletions COMMIT_GUIDELINES.md
View file
Open in desktop
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
Loading