Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
RickyRAV committed Oct 15, 2023
1 parent 96d1f0b commit 21e7bdc
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,23 @@

### Semantic JIRA Commit Messages
`git commit -m ITP-TicketNumber message`

### Semantic Branch Names
Format: `<type>/#<issueNumber>-<alias>`
#### Example
```
feature/#1-init
^------^ ^---^
| |
| +---> issue's keyword
|
+-------> Type: or feat, chore, docs, fix, refactor, style, or test.
```
**Commit Message Conventions:**
- `feat` or `feature`: (new feature for the user, not a new feature for build script)
- `fix`: (bug fix for the user, not a fix to a build script)
- `docs`: (changes to the documentation)
- `style`: (formatting, missing semi colons, etc; no production code change)
- `refactor`: (refactoring production code, eg. renaming a variable)
- `test`: (adding missing tests, refactoring tests; no production code change)
- `chore`: (updating grunt tasks etc; no production code change)

0 comments on commit 21e7bdc

Please sign in to comment.