UBC-MDS / forest-fire-area-prediction

This project aims to predict the burned area of forest fires in the northeast region of Portugal, using meteorological and soil moisture data.
https://ubc-mds.github.io/forest-fire-area-prediction/reports/forest_fire_analysis_report.html
MIT License
9 stars 10 forks source link

Git collaboration approach #5

Open gauthampughazhendhi opened 2 years ago

gauthampughazhendhi commented 2 years ago

The following approach is to ensure a clean main branch and robust collaboration.

  1. We will never work on the main branch because the main branch should only have stable, tested code. We would use a branch named dev in the UBC-MDS to which we raise PRs from our forked repos.
  2. We use feature/feature_name ex: feature/data_download_script in our forked repos to implement new features for our project.
  3. Once we are done with a feature we raise a PR from the feature/feature_name branch in the forked repo to the dev branch in the UBC-MDS repo. Reviewers will merge that with the dev branch if the changes look good, otherwise add comments to revise them.
  4. Once the dev branch in the UBC-MDS repo is clean and stable with all the features for a particular milestone, we merge it with the main branch.
  5. Important: Pull changes from the dev branch of the UBC-MDS repo to our local forked repo after a member has added a feature before starting a new feature. Then, create a feature branch named feature/feature_name based on the dev branch.
gauthampughazhendhi commented 2 years ago

Please go through this once before you start your work, always work on feature/feature_name branches.

gauthampughazhendhi commented 2 years ago

This need not be closed as it might be helpful for collaborators.