Contrib guide git workflow cycle improvement
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 24
- Forks
- 15
- Avg merge
- 10d 3h
- Merged PRs (30d)
- 1
Description
On the contributor guide: https://docs.rc.uab.edu/contributing/contributor_guide/
Make the git workflow cycle more explicit and step-by-step at a high level.
One-time setup:
- Fork central repo
- Clone fork to local development environment (laptop, etc.)
Cycle to start a new feature:
- Sync fork from central
- Pull from fork to local
- Checkout main branch
- Create and checkout a new branch
feat-... - Perform development cycle (change, test, commit)
- Resync (1 & 2 again) and deal with any conflicts
- Push branch to fork
- Make pull request from fork to central
Then explain how to do each step in detail in separate sections.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the contributor guide at https://docs.rc.uab.edu/contributing/contributor_guide/ and review its existing git workflow. Make the setup and feature-cycle steps explicit in the listed order, then add separate sections explaining each step; the work is done when a newcomer can follow the full cycle from fork setup through pull request.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100