| 1 |
|
| 2 | ## Contributing ##
|
| 3 |
|
| 4 | Please read this doc before start to use this repo. We have a set of guidelines that should be followed.
|
| 5 |
|
| 6 | Feel free to propose changes to this document using a pull request.
|
| 7 |
|
| 8 | * Code patterns
|
| 9 |
|
| 10 | ### Available Scripts ###
|
| 11 |
|
| 12 | Local Development enviroment
|
| 13 |
|
| 14 | Build for production
|
| 15 | ```
|
| 16 | npm run build
|
| 17 | ```
|
| 18 | Run unit testing
|
| 19 | ```
|
| 20 | npm test
|
| 21 | ```
|
| 22 |
|
| 23 | ### Git Workflow ###
|
| 24 |
|
| 25 | We use [GitFlow](http://nvie.com/posts/a-successful-git-branching-model/).
|
| 26 |
|
| 27 | ### Branching
|
| 28 | - ```feature/feature-name``` to new features.
|
| 29 | - ```fix/bug-name``` to fix bugs.
|
| 30 | - ```improvement/improvement-name``` to improvement code.
|
| 31 |
|
| 32 | ### Commit messages ###
|
| 33 |
|
| 34 | - Use emoji at the beginning of each message. It help us to identify what's the purpose for each commit.
|
| 35 |
|
| 36 | | Code. | Emoji | Description |
|
| 37 | |-----------------------|---------------------|-------------------------------------------------|
|
| 38 | | `:art:` | :art: | when improving the format/structure of the code |
|
| 39 | | `:racehorse:` | :racehorse: | when improving performance |
|
| 40 | | `:memo:` | :memo: | when writing docs |
|
| 41 | | `:bug:` | :bug: | when fixing a bug |
|
| 42 | | `:fire:` | :fire: | when removing code or files |
|
| 43 | | `:green_heart:` | :green_heart: | when work with CI |
|
| 44 | | `:white_check_mark:` | :white_check_mark: | when work with tests |
|
| 45 | | `:lock:` | :lock: | when dealing with security |
|
| 46 | | `:arrow_up:` | :arrow_up: | when upgrading dependencies |
|
| 47 | | `:arrow_down:` | :arrow_down: | when downgrading dependencies |
|
| 48 | | `:shirt:` | :shirt: | when removing linter warnings |
|
| 49 | | `:bulb:` | :bulb: | new idea |
|
| 50 | | `:construction:` | :construction: | work in progress |
|
| 51 | | `:heavy_plus_sign:` | :heavy_plus_sign: | when adding feature |
|
| 52 | | `:heavy_minus_sign:` | :heavy_minus_sign: | when removing feature |
|
| 53 | | `:facepunch:` | :facepunch: | when resolving conflicts |
|
| 54 | | `:hammer:` | :hammer: | when changing configuration files |
|
| 55 |
|
| 56 |
|
| 57 | Commit exemple:
|
| 58 | ```
|
| 59 | git commit -m ":arrow_up: Update Carthage dependencies"
|
| 60 | ```
|
| 61 |
|
| 62 | ### Pull Requests ###
|
| 63 |
|
| 64 | All Pull Request must be made to the `develop branch`.
|
| 65 |
|
| 66 | Before opening a Pull Request, verify if all unit tests passed,
|
| 67 | we have CI tools to run tests, if it fails [you will be notified](https://www.youtube.com/watch?v=mmLRTVYgEq4).
|
| 68 |
|
| 69 |
|
| 70 | ### Releasing a new version ###
|
| 71 |
|
| 72 | Currently, the release proccess requires you to:
|
| 73 | 1. Open a release branch, following gitflow branching conventions (`release/vx.x.x`), from `develop branch`.
|
| 74 | 2. Manually update the changelog.
|
| 75 | 3. Commit your changes.
|
| 76 | 4. Run the `npm version [<newversion>]` command to version bump [More information about npm version](https://docs.npmjs.com/cli/version).
|
| 77 | 5. Push the tags. (`git push --tags`)
|
| 78 | 6. Push the release branch. (`git push`)
|
| 79 | 7. Create pull request against the `develop branch` and the `master branch`.
|
| 80 | |
| \ | No newline at end of file |