Skip to content

Latest commit

 

History

History
88 lines (73 loc) · 4.22 KB

2-contribute.md

File metadata and controls

88 lines (73 loc) · 4.22 KB

2. Contribute!

⬅️ Back to Set Up

2.1. ⬇️ Download this repository

First, we need to download or clone as it's called in git speak, this repository.

For more details, follow the instructions in the GitHub Docs.

2.2. 🌳 Create a branch

  • In the top navigation bar, click Current Branch: main
  • Click on the Branches tab if you aren't already there
  • Click on New Branch
    Current Branch button
  • Name your branch: githubhandle-contribution
    New Branch Dialog
  • Now you are on you're new branch! 🎉
  • Click Publish Branch to save your branch to github.com
    Publish branch
  • Click on Open the repository page on GitHub in your browser and see that our branch to available for everyone
  • Click main in the repository page on github.com to see the list of all branches
    Branch on github.com

2.3. 📝 Create a markdown file

  • From within your branch, click Open the repository in your external editor
    Open in VS Code
  • On the left navigation bar, click the contributions folder
    new file in contributions
  • Then select the new file icon
    new file icon
  • type githubhandle.md
    • for example, my handle is rmw so I typed rmw.md
    • if your handle is octocat, you'd type octocat.md
    • ℹ️ The .md tells the computer that this is a markdown file!
      named markdown file
  • Click on the file you just created
  • Type # @githubhandle's contribution!
  • Press command + shift + v to show a preview of your markdown file
  • In the top navigation bar, click View then Editor Layout then Two Columns
    Two column layout
  • Drag the tab that starts with Preview over to the second column.
    Drag Preview tab
  • 🎉 Now we can see our updates as we type them!
    Markdown preview

2.4. Create a Pull Request

  • Open GitHub Desktop
  • See that our changes are visible
  • At the bottom left, type a commit message title, such as @githubhandle's first commit!
  • Click Commit to yourbranchname
    commit changes
  • And we've made our first commit! 🥳
  • Click Push origin to save our changes on github.com
    publish branch
  • Click Create Pull Request
    create pr
  • This will take you to github.com
  • Answer the first question in the pull request template -- and use markdown if you can! (Don't worry, though, we will play with a lot more)
    pr description
  • Click on the arrow next to Create pull request
  • Select Create draft pull request
    create draft pr
  • Click Create draft pull request
  • 🎉 Tada! Your draft PR has been created!
    draft pr created

Now for the fun stuff! Let's start learning and playing with markdown!