inspired by first-contributions
This repo was created to help new FAFers(and not only FAFers!) to learn how VCS, GIT, open-source contributions and team developement works.
If you don't have git on your machine, install it.
Note: If you faced any problem following this guide please create a new issue or contact me on [email protected] or https://www.facebook.com/str.dr4605
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.
Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the clone 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 quote 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/this-is-you/faf-contributions.git
where this-is-you is your GitHub username. Here you're copying the contents of the first-contributions repository in GitHub to your computer.
Change to the repository directory on your computer (if you are not already there):
cd faf-contributions
Now create a branch using the git branch command:
git branch <add-your-new-branch-name>
move to created branch using the git checkout command:
git checkout <add-your-new-branch-name>
OR use shortcut
git checkout -b command:
git checkout -b <add-your-new-branch-name>
For example:
git checkout -b add-dragos-strainu
(The name of the branch does not need to have the word add in it, but it's a reasonable thing to include because the purpose of this branch is to add your name to a list.)
Now open contributors.md file in a text editor, add your name and group to it using this format:
1. [FirstName LastName FAF-*](link to your github or facebook or instagram profile)
always start with 1. because markdown file will display ordered list even if all items starts with 1.. See more here.
Note: Don't add it at the beginning or end of the file. Put it anywhere in between. Now, save the file.
If you go to the project directory and execute the command git status, you'll see there are 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 Contributors list"
replacing <your-name> with your name.
Push your 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.
If you go to your 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 master branch of this project. You will get a notification email once the changes have been merged.
Congrats! You just completed the standard fork -> clone -> edit -> PR workflow that you'll encounter often as a contributor!