Connecting developers with mentors worldwide.
Installing the node modules
npm install
or
yarn
Starting the server
npm start
or
yarn start
This section describes the workflow we are going to follow when working in a new feature or fixing a bug. If you want to contribute, please follow these steps:
- Fork this project
- Clone the forked project to your local environment, for example:
git clone [email protected]:crysfel/coding-coach-front-end.git(Make sure to replace the URL to your own repository). - Add the original project as a remote, for this example the name is
upstream, feel free to use whatever name you want.git remote add upstream [email protected]:Coding-Coach/coding-coach.git.
Forking the project will create a copy of that project in your own GitHub account, you will commit your work agains your own repository.
In order to update your local environment to the latest version on development, you will have to pull the changes using the upstream repository, for example: git pull upstream development. This will pull all the new commits from the origin repository to your local environment.
When working on a new feature, create a new branch feature/something from the development branch, for example feature/login-form. Commit your work agains this new branch and push everything to your forked project. Once everything is completed, you should create a PR to the original project. Make sure to add a description about your work and a link to the trello task.
When fixing a bug, create a new branch fix/something from the development branch, for example fix/css-btn-issues. When completed, push your commits to your forked repository and create a PR from there. Please make sure to describe what was the problem and how did you fix it.
Let's say you've been working on a feature for a couple days, most likely there are new changes in development and your branch is behind. In order to update it to the latest (You might not need/want to do this) you need to pull the latest changes to develop and then rebase your current branch.
$ git checkout development
$ git pull upstream development
$ git checkout feature/something-awesome
$ git rebase development
After this, your commits will be on top of the development commits. From here you can push to your origin repository and create a PR.
You might have some conflicts while rebasing, try to resolve the conflicts for each individual commit. Rebasing is intimidating at the begining, if you need help don't be afraid to reach out in slack.
In order to merge a PR, there should be a couple of approval reviews. Once is approved, we should merge to the development branch using the Squash button in github.
When using squash, all the commits will be squashed into one. The idea is to merge features/fixes as oppose of merging each individual commit. This helps when looking back in time for changes in the code base, and if the PR has a great comment, it's easier to know why that code was introduced.