This project aims to simplify and guide the way, beginners can make their first contribution towards open-source. If you are looking to make your first contribution, follow the steps below.
To participate in Hacktoberfest, signup on Hacktoberfest Website using your GitHub or GitLab account.
Fork this repository by clicking on the fork button on the top of this page or you can just simply click here. This will create a copy of this repository in your account.
Install git and setup in your computer. Download and install it from here. Or you can make changings on the GitHub too.
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
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-username/Hacktoberfest.git
where your-username
is your GitHub username. Here you're copying the contents of the first-contributions repository on GitHub to your computer.
Change to the repository directory on your computer (if you are not already there):
cd Hacktoberfest
Now create a branch using the git switch
command:
git switch -c your-new-branch-name
For example:
git switch -c add-ehmad-saeed
Now open Contributors.md
file in a text editor, add your name and GitHub profile URL to it. Now, save the file.
For example:
- [Your Good Name](https://github.com/ehmadsaeed)
If you go to the project directory and execute the command git status
, you'll see there are some changes.
Add those changes to the branch you just created using the git add
command:
git add Contributors.md
Now commit those changes using the git commit
command:
git commit -m "Add your-name to the Contributors list"
replacing your-name
with your username.
Push your changes using the command git push
:
git push origin -u your-branch-name
replacing your-branch-name
with the name of the branch you created earlier.
If you go to current repository on GitHub, you'll see a Compare & pull request
button. Click on that button. Now submit the pull request.
Soon I'll be merging all your changes into the main branch of this project and adding hactoberfest-accepted
tag to your PR. You will get a notification email once the changes have been merged.
Congrats! You just completed the standard fork -> clone -> edit -> pull request workflow that you'll often encounter as a contributor!
Now you can search for beginner-friendly
and good first issue
tags on GitHub and contribute to those projects.
Happy coding! 🎉
- MIT © Ehmad Saeed
- Code of Conduct