First Contribution
Hello, soldier! Welcome to the first contribution page. Here, you will learn how to contribute to open-source projects. This page will guide you through the process of making your first contribution to an open-source project on GitHub.
What is open source and why do I need to care about it?
Big question, right? to get more context start by watching this video:
Before you start make sure:
- You have a Github account. if not, you can create one here.
- You have a Git client installed on your computer. more details here.
- You have a code editor installed on your computer. more details here.
- You have a basic understanding of HTML, CSS and JavaScript.
Ready? let's go:
- Browse to this repository devc-casa-hacktoberfest
- Fork this repository by clicking the Fork button at the top right corner of this page.
- Clone your forked repository to your computer. You can do that by clicking on the green button that says Code and copy the URL.
- Open your terminal and run the following command:
git clone git@github.com:xxxx/devc-casa-hacktoberfest.git
Replace xxxx with your Github username. - Open the project in your code editor and navigate to the open-source project folder.
cd devc-casa-hacktoberfest code .
- Create branch with your firstName and lastName, ex: firstName_lastName . Never use the master branch to create PR.
git checkout -b firstName_lastName
- Add your file firstName_lastName.yml (ex:firstName_lastName.yml) in the contributors/ directory in that branch.
touch firstName_lastName.yml
- Edit the file and add your informations.
firstName: your_firstname
lastName: your_lastname
bio: Full-stack web developer at XXX
github: your_github_username - Commit your changes.
git add . git commit -m add firstName_lastName.yml
- Push your changes to Github.
git push origin firstName_lastName
- Go back to Github and open a Pull Request. You can do that by going to your forked repository and click on the button that says Pull Request. more details here.
- Wait for your Pull Request to be reviewed and merged.
- Congratulations! You have made your first contribution to an open source project. your profile will be added to the contributors list.