CONTRIBUTING.md

Contributing

Submit bugs as GitHub Issues.

Submit contributions as Pull Requests.

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: <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
• 👾 :space_invader: when using generated files

If you do not see an exact emoji match, use the best matching emoji.

Example

:memo: Update CONTRIBUTING.md

Update Contributing.md with new emoji categories
Update Contributing.md with new template

Resolves: #12345

Credits

This is derived from oktasdk-java's CONTRIBUTING.md which itself is derived from Atom's.