Skip to content

Commit

Permalink
doc: Update contributing instructions regarding commit format
Browse files Browse the repository at this point in the history
Make it optional, so it is easier to accept new PRs
  • Loading branch information
jrsnen authored Feb 22, 2022
1 parent 819d8ac commit 6b0ee4c
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ When issuing a pull request (PR) to uvgRTP. Please consider the following aspect
- Make sure you don't have merge commits in your PR, the PR will be merged automatically when accepted. If your PR gets outdated, rebase the branch instead.
- If you are requested to change the PR, avoid adding new commits unless the changes are large enough. It is tempting to add changes in new commits, but PRs with multiple redundant commits will not be accepted. Use `git squash` or `git commit --amend` to change the commits and then force push to your fork.

### Commit format, please remember to add subsystem to commit format!
### Commit format (optional)

uvgRTP follows a specific commit format. The commit header begins with a prefix. List of current usd prefixes can be found in [here](docs/subsystems). The "common:"-prefix is used for modules not found in the list and for changes that affect more than one module. Try to limit line length of commit message to 72 character for better readability in different environments.

Expand Down

0 comments on commit 6b0ee4c

Please sign in to comment.