hackforla / hackforla/VRMS

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

Open
#1,814 1 comment 0 reactions 0 assignees View on GitHub
complexity: medium feature: Github Actions ready for dev lead role: Dev Lead size: 0.5pt
Dominant language
JavaScript
Stars
61
Forks
101
PR merge metrics
No merged PRs in 30d

Description

### 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](https://github.com/hackforla/VRMS)
- General Git documentation: [Git Docs](https://git-scm.com/doc)
- Example of a GitHub wiki structure: [GitHub Wiki Guide](https://docs.github.com/en/communities/documenting-your-project-with-wikis/about-wikis)
- Git commands commonly used in the Pull Request workflow:
- `git checkout -b `
- `git push origin `
- `git fetch origin `
- `git rebase origin/main`
- `git merge origin/main`
- `git pull --rebase`
- `git push --force-with-lease` (when rebasing)

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.