diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..b5f0fa8c1 --- /dev/null +++ b/CONTRIBUTING.md @@ -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 + + Short Description of Commit + + More detailed description of commit + + Resolves: + +#### 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 \ No newline at end of file diff --git a/README.md b/README.md index c0eaaa206..6504da6fb 100644 --- a/README.md +++ b/README.md @@ -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