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

Document Git Commands for Pull Request Workflow and Add to VRMS Wiki #1814

Open
4 tasks
JackHaeg opened this issue Nov 19, 2024 · 1 comment
Open
4 tasks
Assignees
Labels
draft Not ready for prioritization yet feature: Github Actions ready for dev lead Add to issue when dev lead needs to take some action role: Dev Lead size: 0.5pt Can be done in 2-3 hours or less

Comments

@JackHaeg
Copy link
Member

Overview

The purpose of this issue is to document Git commands specific to the Pull Request workflow in VRMS. This includes commands for creating, managing, and updating Pull Requests. The documentation will be added to the project's GitHub wiki to help contributors follow a consistent workflow.

Action Items

  • Compile a list of Git commands related to the Pull Request workflow, including:
    • Creating branches for features or fixes.
    • Pushing changes to remote branches.
    • Fetching updates from the base branch.
    • Rebasing or merging changes from the base branch into the feature branch.
    • Resolving conflicts.
  • Write concise descriptions and usage examples for each command.
  • Review the documentation for clarity, accuracy, and completeness.
  • Add the finalized documentation to the VRMS GitHub wiki under a dedicated section for "Pull Request Workflow."

Resources/Instructions

  • VRMS GitHub repository: VRMS Repository Link
  • General Git documentation: Git Docs
  • Example of a GitHub wiki structure: GitHub Wiki Guide
  • Git commands commonly used in the Pull Request workflow:
    • git checkout -b <branch-name>
    • git push origin <branch-name>
    • git fetch origin <branch-name>
    • git rebase origin/main
    • git merge origin/main
    • git pull --rebase
    • git push --force-with-lease (when rebasing)
@JackHaeg JackHaeg added ready for dev lead Add to issue when dev lead needs to take some action feature: Github Actions size: 0.5pt Can be done in 2-3 hours or less role: Dev Lead labels Nov 19, 2024
@JackHaeg JackHaeg added this to the 05.01 Team Workflow milestone Nov 19, 2024
@github-project-automation github-project-automation bot moved this to New Issue Approval in P: VRMS: Project Board Nov 19, 2024
@JackHaeg JackHaeg added the draft Not ready for prioritization yet label Nov 19, 2024
@JackHaeg
Copy link
Member Author

@trillium Please review this issue when you have a moment and make any edits you see fit :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
draft Not ready for prioritization yet feature: Github Actions ready for dev lead Add to issue when dev lead needs to take some action role: Dev Lead size: 0.5pt Can be done in 2-3 hours or less
Projects
Status: New Issue Approval
Development

No branches or pull requests

2 participants