Skip to content

1. Quick Edits

DavidAbraham082 edited this page Dec 14, 2021 · 16 revisions

Editing on GitHub is sooo much better than sending an email in the format of change x to y. It's fast, fun, and gives you credits on your GitHub stats.

  1. Select "Edit" on the profile, which will take you to the GitHub markdown.
    Edit Profile Figure: Click "Edit" on the Profile

  2. Click the Edit icon to change the profile text
    Select Edit in GitHub Figure: Click the pencil icon in GitHub

  3. Make the changes to the profile (in markdown)
    Select Edit in GitHub Figure: Make any changes in the markdown

  4. Commit the changes
    Select Edit in GitHub Figure: Tell them what you did, then click "Commit changes"

  5. Open Pull Request and assign reviewers

    If you're submitting a change for someone else's profile, it's always a good idea to add them as a reviewer. This allows them to be notified of the change via email.

    Add Reviewers to PR Figure: Adam's profile is being edited so we'll add him as a reviewer to the pull request

  6. Create Pull Request Once you've done as many changes as you want, then pass it over to the reviewers by clicking "Create pull request"
    Select Edit in GitHub Figure: Click "Create pull request"

  7. Done! Once you see a green "Open" you just need to be patient
    The red crosses are normal, you are just waiting for the reviewers. Select Edit in GitHub Figure: The green "Open" means you're done! The Pull request has been sent for approval


Next Step: Using Markdown >