Repository structure and how to interact with it

This repo follows the Gitflow workflow: https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow

Branch Structure

  • main: Release branch from which tagged releases are generated.

  • develop: Development branch where updates are aggregated between releases

  • feature_branch_name: Feature branches should be forked off of develop, and should be named with a human readable intuitive name. Delete feature branches once merged into develop and work in them is complete.

Developer Overview

We recommend that developers use the following workflow:

First, setup your working environment

  1. Create a fork of the repository into your github account by clicking the Fork icon on the right top corner of the main github EPRV-RCN/RVdata repo page.

  2. Clone your fork to your local computer: git clone git@github.com:YourGithubID/RVdata.git

  3. Setup a new remote named upstream that points to the project level repository: git remote add upstream git@github.com:EPRV-RCN/RVdata.git

To add a new feature or bugfix to the repository:

  1. Ensure that you are on the develop branch: git checkout develop

  2. Create a feature branch off of develop for your new work. Bugfix branches should prefix with bugfix. git checkout -b feature_branch_name

  3. Make your changes, commit them with a useful commit message, and push to your fork: git commit -m "Description of committed changes git push origin feature_branch_name

  4. Setup a pull request from your feature branch into the project level develop branch. Use the Pull requests menu item on the top bar of github.com. Be sure that the pull request points into the EPRV-RCN/RVdata develop branch. This will trigger a review request. Two reviews from the core development team are required before merging.

  5. Iterate with reviewers as needed, using the pull request to capture discussion comments. Once the reviewers approve the pull request, the original author is responsible for merging. If you encounter a merge conflict, ask for help. Do not proceed!

Testing & Integration

[In progress]