Skip to content

Latest commit

 

History

History
41 lines (30 loc) · 1.32 KB

CONTRIBUTING.md

File metadata and controls

41 lines (30 loc) · 1.32 KB

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: when creating a new feature
  • 🐛 :bug: when fixing a bug
  • :white_check_mark: when adding tests
  • 🎨 :art: when improving the format/structure of the code
  • 📝 :memo: when writing docs
  • 🔥 :fire: when removing code or files
  • 📦 :package when pushing a new release
  • ⬆️ :arrow_up: when upgrading dependencies
  • ⬇️ :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