Skip to content

Instantly share code, notes, and snippets.

@guyandtheworld
Last active December 26, 2021 22:37
Show Gist options
  • Star 2 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save guyandtheworld/14dfdb6fe5bfe744badaf7ef4c8660d9 to your computer and use it in GitHub Desktop.
Save guyandtheworld/14dfdb6fe5bfe744badaf7ef4c8660d9 to your computer and use it in GitHub Desktop.

For aspiring programmers looking for real-world experience of working in a team using Github we made a tool to help you close your first issue!

Close Your First Github Issue

Don't feel confident using GitHub in a team? Practice the workflow by closing your first issue, step by step. For a guided complete tutorial with images, refer to our README

Step 1. Join the GitHub organisation

Use this invite link to get our bot to send you an invite in your email to join our Github organisation so that the issue can be assigned to your Github username. Use the following command inside the #get-started channel to get the invite.

/join-github-org your-github-username

Note: Once you've accepted the invite (check your email) you will be assigned your very first issue

Step 2. Fork this repository

Fork the repository where you'll be closing your first issue by clicking on the fork button on the top of the page.

This will create a copy of this repository in your account.

Step 3. Clone your forked repository

Now clone the forked repository to your machine.

Go to your GitHub account, open the forked repository, click on the code button and then click the copy to clipboard icon.

Open a terminal and run the following git command:

git clone "url you just copied"

where "url you just copied" (without the quotation marks) is the url to this repository (your fork of this project). See the previous steps to obtain the url.

For example:

git clone https://github.com/<your-github-username>/close-my-first-issue.git

Here you're copying the contents of the close-my-first-issue repository on GitHub to your computer.

PS. If you don't have git on your machine, install it.

Step 4. Create and checkout a local branch

Change to the repository directory on your computer (if you are not already there):

cd close-my-first-issue

Now create a branch using the git checkout command:

git checkout -b new-branch-name

For example:

git checkout -b add-<your-github-username>

Step 5. Add, stage and commit local changes

Now create profiles/<your-github-username>.md in your editor, add ## Hi, I'm <your-github-username> to the file and then save it.

Upon executing the command git status, you'll see there are changes.

Stage those changes with the git add command:

git add profiles/<your-github-username>.md

And commit those changes using the git commit command:

git commit -m "add <your-github-username>"

Step 6. Push local commits to remote branch

Push your changes using the command git push:

git push origin add-<your-github-username>

Step 7. Open a pull request

If you go to your repository on GitHub, you'll see a Compare & pull request button.

Click on that button to start creating a pull request.

Someone from our organisation will then be notified of your pull request and either approve and merge your updates, or request changes.

You will get a notification in either case.

Congratulations!

You've just completed the standard fork -> clone -> branch -> commit -> push -> open pull request workflow that is used to power up to 190 million GitHub repositories.

Want more tasks like this to learn more and make your practical knowledge better? Stick around in our server for further announcements!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment