Skip to content

Commit

Permalink
📝 Add CONTRIBUTING.md (#52)
Browse files Browse the repository at this point in the history
Add contributing guidelines for future commit messages
  • Loading branch information
alanzhou-okta authored and lboyette-okta committed Oct 26, 2016
1 parent 7310870 commit 9140578
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 0 deletions.
41 changes: 41 additions & 0 deletions CONTRIBUTING.md
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
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ Okta Auth JS is a wrapper around [Okta's authentication API](http://developer.ok

If you want to use the SDK, see the instructions on [the Okta Auth SDK developer page](http://developer.okta.com/docs/guides/okta_auth_sdk.html).

If you wish to contribute to okta-auth-js, please read the following [contributing guidelines](./CONTRIBUTING.md)

If you want to modify the SDK, use the following instructions.

## Building the SDK
Expand Down

0 comments on commit 9140578

Please sign in to comment.