-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
55 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
<!-- | ||
Title: | ||
The title should be in the form of type: subject, where type is one of the following: | ||
- build: Changes that affect the build system or external dependencies | ||
- ci: Changes to our CI configuration files and scripts | ||
- docs: Documentation only changes | ||
- feat: A new feature | ||
- fix: A bug fix | ||
- perf: A code change that improves performance | ||
- refactor: A code change that neither fixes a bug nor adds a feature | ||
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc.) | ||
- **tests**: Adding missing tests or correcting existing tests | ||
Subject: | ||
The subject contains a succinct description of the change: | ||
- use the imperative, present tense: "change" not "changed" nor "changes" | ||
- don't capitalize the first letter | ||
- no dot (.) at the end | ||
--> | ||
|
||
# Issue Number: #<!-- issue number --> | ||
|
||
# Body | ||
|
||
<!-- | ||
Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". | ||
The body should include the motivation for the change and contrast this with previous behavior. | ||
--> | ||
|
||
# Footer | ||
|
||
<!-- | ||
The footer should contain any information about Breaking Changes and is also the place to reference GitHub issues that this pull request Closes. | ||
Breaking Changes should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this. | ||
If there are no breaking changes, you can remove this section. | ||
--> | ||
|
||
## BREAKING CHANGES | ||
|
||
Describe breaking changes here | ||
|
||
### BEFORE | ||
|
||
```txt | ||
Previous code example here | ||
``` | ||
|
||
### AFTER | ||
|
||
```txt | ||
New code example here | ||
``` |