Contributing to Okta Open Source Repos

Style

Git Commit Messages

We use a simplified form of Atom's 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