Skip to content

Commit

Permalink
Fix/moving contributing (#12) (#13)
Browse files Browse the repository at this point in the history
* Moving the contributing file

* Fix typo
  • Loading branch information
Oscar Torreno authored Jun 11, 2018
1 parent aff24c5 commit a2aea0e
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions .github/CONTRIBUTING.md → CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ little bit helps, and credit will always be given.

## Formatting Style

In order to have a standarised code base, we only accept code that is formatted according to the Google rules for C++ with a column width of 120 characters and an identation of 4 whitespaces. For this purpose, we use `clang-format`, which can be installed in MacOs by executing the next command: `brew install clang-format`.
In order to have a standarised code base, we only accept code that is formatted according to the Google rules for C++ with a column width of 120 characters and an indentation of 4 whitespaces. For this purpose, we use `clang-format`, which can be installed in MacOs by executing the next command: `brew install clang-format`.
We use the `clang-format` plugin for the VS Code editor to format our codes. This plugin uses the `clang-format` program and the aforementioned rules under the hood.

## Branching model
Expand All @@ -30,7 +30,7 @@ Our branching model has two permanent branches, **develop** and **master**. We a
## Contribution process

In order to contribute to the code base, we follow the next process :
1. The main branch is develop, every developer should pull the current status of the branch before stating to develop any new feature.
1. The main branch is `develop`, every developer should pull the current status of the branch before starting to develop any new feature.
`git pull`
1. Create a new branch with the following pattern "feature/[name_of_the_feature]"
`git checkout -b feature/example_feature`
Expand Down

0 comments on commit a2aea0e

Please sign in to comment.