Pull Request Workflow

Pull Request Workflow#

All contributions should be made from a fork off of the Wildbook repo. While there are a number of repositories for specific Wildbook communities, large scale development is driven from the main repository.

Fork Wildbook#

To start, you will need to be signed in to your GitHub account, have admin access to your OS’s terminal, and have Git installed.

  1. From your browser, in the top right corner of the Wildbook repo, click the Fork button. Confirm to be redirected to your own fork (check the url for your USERNAME in the namespace).

  2. In your terminal, enter the command git clone https://github.com/USERNAME/Wildbook.git

  3. Once the Wildbook directory becomes available in your working directory, move to it with the command cd Wildbook

  4. Add a reference to the original repo, denoting it as the upstream repo.

git remote add upstream https://github.com/WildMeOrg/Wildbook
git fetch upstream

Note: The same forking process is used for WildbookExport.

Create Local Branch#

You will want to work in a branch when doing any feature development you want to provide to the original project.

  1. Verify you are on the master branch. The branch you have checked out will be used as the base for your new branch, so you typically want to start from master. git checkout master

  2. Create your feature branch. It can be helpful to include the issue number (ISSUENUMBER) you are working to address. git branch ISSUENUMBER-FEATUREBRANCHNAME

  3. Change to your feature branch so your changes are grouped together. git checkout ISSUENUMBER-FEATUREBRANCHNAME

  4. Update your branch (this is not needed if you just created new branch, but is a good habit to get into). git pull upstream master

Note: The primary branch you’ll be working from for Scout or WildbookExport is main.

Set Up Development Environment with Docker#

For easiest development, you will need to set up your development environment to work with Docker. See devops/development/README.md for detailed instructions.

Deploy frontend#

To setup frontend, we need to deploy the React build to Wildbook, please follow the detailed instructions provided in the frontend/README.md file within the project directory.

Making Local Changes#

Make the code changes necessary for the issue you’re working on. The following git commands may prove useful.

  • git log: lastest commits of current branch

  • git status: current staged and unstaged modifications

  • git diff --staged: the differences between the staging area and the last commit

  • `git add : add files that have changes to staging in preparation for commit

  • git commit: commits the stagged files, opens a text editor for you to write a commit log

Submit PR#

Up to this point, all changes have been done to your local copy of Wildbook. You need to push the new commits to a remote branch to start the PR process.

  1. Now’s the time clean up your PR if you choose to squash commits, but this is not required. If you’re looking for more information on these practices, see this pull request tutorial.

  2. Push to the remote version of your branch git push <remote> <local branch> git push origin ISSUENUMBER-FEATUREBRANCHNAME

  3. When prompted, provide your username and GitHub Personal Access Token. If you do not have a GitHub Personal Access Token, or do not have one with the correct permissions for your newly forked repository, you will need to create a Personal Access Token.

  4. Check the fork’s page on GitHub to verify that you see a new branch with your added commits. You should see a line saying “This branch is X commits ahead” and a Pull request link.

  5. Click the Pull request link to open a form that says “Able to merge”. (If it says there are merge conflicts, go the for help).

  6. Use an explicit title for the PR and provide details in the comment area. Details can include text, or images, and should provide details as to what was done and why design decisions were made.

  7. Click Create a pull request.

Respond to feedback#

At this point, it’s on us to get you feedback on your submission! Someone from the Wild Me team will review the project and provide any feedback that may be necessary. If changes are recommended, you’ll need to checkout the branch you were working from, update the branch, and make these changes locally.

  1. git checkout ISSUENUMBER-FEATUREBRANCHNAME

  2. git pull upstream master

  3. Make required changes

  4. git add <filename> for all files impacted by changes

  5. Determine which method would be most appropriate for updating your PR

  • git commit --ammend if the changes are small stylistic changes

  • git commit if the changes involved significant rework and require additional details

Other branches#

The code for specific Wildbook platforms is available in different branches under the Wildbook repo. The only contributions made to these repos are:

  • standardizations by the Wild Me team to get rid of historical custom code

  • merges of master into the branch by the Wild Me team

  • updates to .properties files, such as translations, custom fields, or species management

  • updates to IA.json to manage locationIDs available in the system

All custom feature work that is pushed to a non-master branch will be closed unless discussed and approved by the Wild Me team in advance.

Contents