Contributing a Pull Request

Resources

These articles were used to write these instructions. If we made any errors, email us at support@openboxes.com with any feedback/suggestions.

• https://guides.github.com/activities/forking/
• https://help.github.com/en/articles/syncing-a-fork
• https://gist.github.com/Chaser324/ce0505fbed06b947d962
• https://help.github.com/en/articles/creating-a-pull-request#changing-the-branch-range-and-destination-repository

New Features or Bug Fixes

Getting Started

1. Create a fork of the openboxes/openboxes repository
2. Clone fork to your local machine

   git clone git@github.com:<username>/openboxes.git
   

3. Add openboxes repo as upstream (one-time only)

   git remote add upstream git://github.com/openboxes/openboxes.git
   

Before you begin development on a new ticket

1. Fetch changes from upstream

   git fetch upstream
   

2. Sync develop

   git checkout develop
   git pull upstream develop
   

Working on a new feature branch

All bug fixes / improvements should be created as branches off the develop branch

1. Checkout develop branch

   git checkout -b feature/<ticket-number-and-description>
   

e.g. feature/1084-make-uploads-directory-configurable

1. Do all development in branch

   git add application.properties
   git commit -m "Made a change to source file"
   

2. Push all changes to branch in your forked repository

   git push
   

3. Create a pull request
4. Title of the pull request should be the same as commit message
5. Check openboxes/openboxes to see if pull request shows up in list https://github.com/openboxes/openboxes/pulls