Project Workflow

Start a new feature

When you're assigned a task on Waffle, before you start writing code you must create a feature branch for the feature you're about to implement.

$ cd /path/to/project
$ git checkout -b name-of-your-feature

Once you complete your task, commit your work and push your branch to your own fork of the repository on GitHub.

Prepare and Submit a Pull Request (PR)

An overview of the development process is described below. Go here for a more detailed, step-by-step description.

1. Preparation

Once you complete your task, make sure you have the latest changes from upstream. You should do the following from your feature branch.

$ git fetch upstream
$ git merge upstream/development

The above commands will merge the latest changes onto your feature branch.

Every time you pull from upstream you want to make sure all test are still passing ✅. This is just a precaution measure to identify and isolate problems that may have been caused from the merge at an early stage, then deal with them right away.

$ bundle exec rspec
$ bundle exec cucumber

If everything looks good, you can push to your repository on GitHub

$ git push origin 

2. Submit a PR

Head over to you repository on GitHub then move to your feature branch. Your should see a green button Compare & pull-request. Click it then on the new page make sure of the following:

• The base fork should be AgileVentures/MetPlus_PETS
• base: develop
• head fork: <your-github-username>/MetPlus_PETS
• compare: <your-feature-branch>

Give your PR a title and add leave a comment explaining your changes. Members of the teams will then review your PR and merge it if there are no issues. In the event that you have to make some changes, commit them to your repository on the same branch. They will automatically be pushed to the PR too. You don't have to submit a new one.

If you encounter any problem or are unsure of something, contact team members on the slack channel.