Skip to content

Add PR help in Working with Git and Github Contributer Documentation #50

Open
@colleenDunlap

Description

@colleenDunlap

Code of Conduct

  • 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 of "Working with Git and Github"

Request or proposal

proposal

Additional Details

No response

Implementation Suggestions

No response

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    Status

    Idea

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions