hackforla / hackforla/peopledepot

docs: How to rebase a branch before a PR

Open
#191 4 comments 0 reactions 0 assignees View on GitHub
complexity: medium feature: docs: PD team documentation PII: FALSE role: dev lead s: PD team size: 2pt
Dominant language
Python
Stars
14
Forks
37
Avg merge
9d 15h
Merged PRs (30d)
5

Description

### Overview

We need documentation for how to rebase a development branch in preparation for opening a PR so that developers can avoid conflicts in their PRs. This happens often enough that we should create this guide even before the MkDocs migration.

### Action Items

- [x] documentation for rebasing a branch onto the latest `main`
- [ ] instructions for resolving merge conflicts
- [ ] instructions for resolving migration file conflicts
- [ ] go to #189, check off the item relating to this issue, and close #189

### Resources/Instructions

- compare rebase with merge, why we want to choose rebase over merge
- steps to rebase
- make sure the code works well in the branch
- optional interactive rebase to simplify commit history
- fetch hackforla/main
- git rebase hackforla/main
- resolve merge conflicts
- resolve migration file conflicts

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.