This project is super simple and begginer friendly to allow everyone to start to contribute to an open source project.
For this tutorial you can either do it directly on GitHub or you can use the Command Line.
If you don't have git on your machine, you can install it.
If you prefer to do it on GitHub, check Introduction to GitHub
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.
Git clone allows you to copying the contents of the awesome-developers-list repository on GitHub to your computer.
βNote: If you are not using the command line, go to step 3
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_here>/awesome-developers-list
Don't forget to change <your_github_username_here>
to your GitHub username.
Change to the repository directory on your computer:
cd awesome-developers-list
Now create a branch using the git checkout
command:
git checkout -b your-new-branch-name
For example:
git checkout -b adding-ada-lovelace
(You can start the name of the branch with adding , to be more consistent)
Alternatively, you can also create a branch directly on your GitHub repository
Now open AwesomeDevelopers.md
file in a text editor and at the end of the file, add your name, role (if you prefer) and a link to your website, github, etc
Example:
[MΓ³nica Fidalgo - Vue|React Developer](https://github.com/MonicaFidalgo/)
To check if your changes are being tracked you can type git status
, and you'll see if there are any changes.
If so, add those changes to the branch you just created using the git add
command:
git add AwesomeDevelopers.md
Now commit those changes using the git commit
command:
git commit -m "Add <your-name> to Developers list"
replacing <your-name>
with your name.
Alternatively, you can edit the file on GitHub itself
And then commit the changes
The git push command is used to upload local repository content to a remote repository.
βNote: If you are not using the command line, go to step 6
Push your computer local changes using the command git push
:
git push origin <add-your-branch-name>
replacing <add-your-branch-name>
with the name of the branch you created earlier.
Go now to the main repository on gitHub, you should be able to see something similar
Now you can create a pr, by adding a description and then submit the pull request. You can also check the changes that you did on the bottom, the before and the after
After that, I will check your pr and merge it to the main branch!
If you liked this step to step, fell free to follow me on GitHub, I have already more ideas that you can contribute as wellβ€οΈ