-
Notifications
You must be signed in to change notification settings - Fork 267
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add contributing guidelines for future commit messages
- Loading branch information
1 parent
7310870
commit 9140578
Showing
2 changed files
with
43 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,41 @@ | ||
# Contributing to Okta Open Source Repos | ||
|
||
## Style | ||
|
||
### Git Commit Messages | ||
|
||
We use a simplified form of [Atom's](https://github.com/atom/atom/blob/master/CONTRIBUTING.md#git-commit-messages) commit convention. | ||
|
||
* Use the present tense ("Adds feature" not "Added feature") | ||
* Limit the first line to 72 characters or less | ||
* Add one feature per commit. If you have multiple features, have multiple commits. | ||
|
||
#### Template | ||
|
||
<emoji> Short Description of Commit | ||
<BLANKLINE> | ||
More detailed description of commit | ||
<BLANKLINE> | ||
Resolves: <Jira # or Issue #> | ||
|
||
#### Emoji Categories | ||
Our categories include: | ||
* :seedling: `:seedling`: when creating a new feature | ||
* :bug: `:bug:` when fixing a bug | ||
* :white_check_mark: `:white_check_mark:` when adding tests | ||
* :art: `:art:` when improving the format/structure of the code | ||
* :memo: `:memo:` when writing docs | ||
* :fire: `:fire:` when removing code or files | ||
* :package: `:package` when pushing a new release | ||
* :arrow_up: `:arrow_up:` when upgrading dependencies | ||
* :arrow_down: `:arrow_down:` when downgrading dependencies | ||
|
||
If you do not see an exact emoji match, use the best matching emoji. | ||
|
||
#### Example | ||
:memo: Updates CONTRIBUTING.md | ||
|
||
Updates Contributing.md with new emoji categories | ||
Updates Contributing.md with new template | ||
|
||
Resolves: OKTA-12345 |
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