Add PR help in Working with Git and Github Contributer Documentation
- Dominant language
- No language data
- Stars
- 188
- Forks
- 7
- PR merge metrics
- No merged PRs in 30d
Description
### Code of Conduct
- [x] I agree to follow Django's Code of Conduct
### Feature Description
1. I'd like to include an image of a sample PR and markup said image highlighting:
a) no reviewers need to be tag
b) commit message best practices
c) CICD tests passing
d) tests present
I'd also like to include a link to the review queue as I didn't realize that we a) need more reviewers and b) DSF wants us hobbyist contributors to review as well.
Finally I'd like to include a Trac ticket image showing how to modify the ticket to a) mark has patch and b) link the PR
I think these visuals could really help those whose English as a second language, as well as the ADHDevs like myself who speak English fine just have problems synthesizing information across a bunch of different places :)
### Problem
I'm always forgetting if we need to tag reviewers (we don't), to add a period at the end of a commit message, etc. and I'm often going back to the discord to ask clarifying questions. I'd like to add more documentation to the [Publishing Work section](https://docs.djangoproject.com/en/dev/internals/contributing/writing-code/working-with-git/#publishing-work) of "Working with Git and Github"
### Request or proposal
proposal
### Additional Details
_No response_
### Implementation Suggestions
_No response_
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with the Publishing Work section of “Working with Git and Github” and review the existing contributor guidance around pull requests. Done should include clear sample PR and Trac visuals, guidance on reviewers, commit messages, CI tests, and test presence, plus links to the review queue and relevant workflow information.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git, github
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100