Close My First Issue

Don't feel confident using GitHub in a team? Practice the workflow by closing your first issue, step by step 💪.

Step 1. Join our GitHub organisation

/join-github-org your-github-username

Note: Once you've accepted the invite (check your email):

1. you will be assigned your very first issue
2. you can reach out to the #community for help whenever you get lost, stuck or overwhelmed

Step 2. Fork this repository

Fork this repository by clicking on the fork button on the top of this 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.

Our mentors 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.

Credits

Special thanks to firstcontributions for inspiring us to build upon their incredible work. We both share a vision of wanting to help beginners to contribute to open source projects, and used their first-contribution repository as a base.

We have not forked their repository or preserved commit history because we wanted to keep things as simple as possible for our community of aspiring contributors. For reference, the original MIT licence can be found in our repository here.

Where to go from here?

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.

If you're wondering what to do next, be sure to introduce yourself and share your programming journey in our super friendly #community.

Experienced mentors check this channel regularly and routinely offer guidance based on what you plan to achieve.