Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: How to rebase a branch before a PR #191

Open
4 tasks
fyliu opened this issue Aug 23, 2023 · 4 comments
Open
4 tasks

docs: How to rebase a branch before a PR #191

fyliu opened this issue Aug 23, 2023 · 4 comments
Labels
complexity: medium feature: docs: PD team documentation documentation on PD team processes and architecture, etc. feature: docs: team guide Same as PD team documentation? role: dev lead s: PD team stakeholder: People Depot Team size: 2pt Can be done in 7-12 hours

Comments

@fyliu
Copy link
Member

fyliu commented Aug 23, 2023

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

  • documentation for rebasing a branch onto the latest main
    • instructions for resolving merge conflicts
    • instructions for resolving migration file conflicts
  • check and release ER: Developer support items from #188 #189 from icebox

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
@fyliu fyliu added size: 2pt Can be done in 7-12 hours s: PD team stakeholder: People Depot Team feature: docs: team guide Same as PD team documentation? role: dev lead feature: docs: PD team documentation documentation on PD team processes and architecture, etc. labels Aug 23, 2023
@fyliu fyliu added this to the 5 - Team Workflow milestone Aug 23, 2023
@alexlaw528 alexlaw528 self-assigned this Oct 8, 2023
@ExperimentsInHonesty
Copy link
Member

@alexlaw528 Please provide update

  1. Progress: "What is the current status of your project? What have you completed and what is left to do?"
  2. Blockers: "Difficulties or errors encountered."
  3. Availability: "How much time will you have this week to work on this issue?"
  4. ETA: "When do you expect this issue to be completed?"
  5. Pictures or links* (if necessary): "Add any pictures or links that will help illustrate what you are working on."
  • remember to add links to the top of the issue if they are going to be needed again.

@alexlaw528
Copy link
Member

@ExperimentsInHonesty Currently in progress. @fyliu should I include the procedure for properly using the django-linear-migration?

@fyliu
Copy link
Member Author

fyliu commented Nov 22, 2023

@alexlaw528 it would be great if you can add that. No worries if you don't get around to it. Thanks!

@fyliu
Copy link
Member Author

fyliu commented May 24, 2024

Moved back to backlog since Alex is no longer here.

@fyliu fyliu removed the feature: docs: PD team documentation documentation on PD team processes and architecture, etc. label Jun 3, 2024
@fyliu fyliu changed the title Docs: how to rebase a branch before a PR [docs] how to rebase a branch before a PR Jun 3, 2024
@fyliu fyliu changed the title [docs] how to rebase a branch before a PR [docs] How to rebase a branch before a PR Jun 3, 2024
@shmonks shmonks moved this to Prioritized Backlog in P: PD: Project Board Jun 7, 2024
@fyliu fyliu changed the title [docs] How to rebase a branch before a PR docs: How to rebase a branch before a PR Jun 10, 2024
@shmonks shmonks added the feature: docs: PD team documentation documentation on PD team processes and architecture, etc. label Oct 31, 2024
@shmonks shmonks mentioned this issue Nov 7, 2024
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
complexity: medium feature: docs: PD team documentation documentation on PD team processes and architecture, etc. feature: docs: team guide Same as PD team documentation? role: dev lead s: PD team stakeholder: People Depot Team size: 2pt Can be done in 7-12 hours
Projects
Status: 📋Prioritized Backlog
Development

No branches or pull requests

4 participants