Contribute To This Project
Logo Created with
π By CandidDeer
Announcement:
Would you like to become a maintainer on this project and help keeping it going? If you are interested, read the maintainer's guide and send me a DM on Twitter.
Quick access index
Overview
- Announcements
- Introduction
- Who is this for?
- Why do I need to do this?
- What am I going to contribute to?
- Translations
- Setup
- Next Steps
- Acknowledgements
Steps
- Contribute
- Step 1 - Forking
- Step 2 - Cloning
- Step 3 - Creating a new branch
- Step 4 - Opening the main html file
- Step 5 - Copying the card template
- Step 6 - Applying your changes
- Step 7 - Committing
- Step 8 - Pushing to GitHub
- Step 9 - Submit a PR
- Step 10 - Celebrate
Introduction
This is a tutorial to help first-time contributors to participate in a simple and easy project.
Objectives
- Make a contribution to an open source project.
- Get more comfortable in using GitHub.
Who is this for?
- This is for absolute beginners. If you know how to write and edit an anchor tag
<a href="" target=""></a>then you should be able to do it. - It is also for those with a little more experience but who want to make their first open source contribution, or get more contributions for more experience and confidence.
Why do I need to do this?
Any web developer, aspiring or experienced needs to use Git version control, and GitHub is the most popular Git hosting service used by everyone. It is also the heart of the Open Source community. Getting comfortable using GitHub is an essential skill. Making a contribution to a project boosts your confidence and gives you something to show on your GitHub profile.
If you are a new developer and you are wondering if you need to learn Git and GitHub then here is the answer: You Should've Learned Git Yesterday.
What am I going to contribute?
You are going to contribute a card just like this one to this project's web page. It will include your name, your Twitter handle, a short description, and 3 links to useful resources for web developers that you recommend.
You will make a copy of the card template inside the HTML file and customize it with your own information.
Translations
This tutorial is also available in other languages
| Arabic | Bangla | English | French | German |
|---|---|---|---|---|
| Hindi | Italian | Japanese | Korean | Polish |
| Portuguese | Russian | Serbian | Spanish | Turkish |
Translations for projects documentations are welcome. Read
Translation Guideto contribute.
Setup! :)
Note: This Tutorial is based on GitHub PC. If you're comfortable with the terminal go to this tutorial (Click Here)
First let's get setup to do the work
- Login to your GitHub account. If you don't yet have an account then join GitHub. I recommend that you do the GitHub Hello World tutorial before you continue.
- Download GitHub Desktop app.
- Alternatively if you are comfortable using Git on the command line you can do so Here is the link to the CLI tutorial.
- If you use VS Code it comes with integrated Git and allows you to do what we need straight from the editor.
- However the simplest and easiest way to follow this tutorial is using GitHub Desktop.
Now that you are all setup let's get on with the business of contributing to the project.
Contribute
Become an open source contributor in 10 easy steps.
Estimated time: Less than 30 minutes.
Step 1: Fork this repository
- The objective here is to make a copy of this project and place it in your account.
- A repository (repo) is how a project is called on GitHub and a fork is a copy of it.
- Make sure you are on the main page of this repo.
 |
|---|
| Click on the Fork button |
- You now have a complete copy of the project in your own account.
Step 2: Clone the repository
- Now we want to make a local copy of the project. That is a copy saved on your own machine.
- Open the GitHub desktop app. In the app:
 |
|---|
| Click on File then Clone repository |
- You will see a list of your projects and forks on GitHub.
- Select
<your-github-username>/Contribute-To-This-Project. - Click Clone
 |
|---|
 |
|---|
- This will take a moment as the project is copied to your hard disk. I recommend that you keep the default path which is usually
..\Documents\GitHub. - Now you have a local copy of the project.
Step 3: Create a new branch
- Once the repo has been cloned and you have it open in GitHub desktop it is time to create a new branch.
- A branch is a way to keep your changes separate from the main part of the project called
Master. For example if things go wrong and you are not happy with your changes you can simply delete the branch and the main project won't be affected.
Current branch, Then click on New |
 |
|---|---|
Create branch |
 |
 |
- You can name it whatever you want, but since this is a branch to add a card with your name to the project, calling it
your-name-cardis good practice because it keeps the intention of this branch clear. - Now you have created a new branch separate from the master.
- For the next steps make sure you are working in this branch. You will see the name of the branch you are on at the top center of the GitHub desktop app where it says Current branch.
Do NOT work on the master branch
Step 4: Open the index.html file
- Now we need to open the file we are going to edit with your favourite code editor.
- Find the project folder on your computer. If you have kept the default this should be something like
your-computer > Documents > GitHub > Contribute-To-This-Project - The
index.htmlfile is directly in theContribute-To-This-Projectfolder. - Open your code editor (Sublime, VS Code, Atom..etc) and use the
Open filecommand and locate the index.html file in the main directory of the project
 |
|---|
- Now you have the file you are going to edit open in your editor and you are ready to start making changes to it.
Step 5: Copy the card template
- We will make a copy of the card template to start working on it
- At the top of the html file, under the
<head>and<header>sections you will find the section labelled== TEMPLATE == - Copy everything within the red square in the image, from the
Contributor card STARTcomment to theContributor card ENDcomment
 |
|---|
- Paste the whole thing directly below the comment indicating it
- Make sure there is a single line of space between your card start and the last card end. It's good practice to keep our code as clear as possible
- Never use a linters or style formatters. The project has Prettier setup
 |
|---|
- This now is your card for you to customize and edit.
Step 6: Apply your changes
- We'll now start editing html, changing the customizable fields in our card.
 |
|---|
- Note: Don't change
class="name"
href="Insert URL here", Type your handle in the text field |
 |
|---|
- If you prefer to use a contact other than Twitter you will need to replace the twitter icon
<i class="fa fa-twitter"></i>by going to Font Awesome Icons searching for the right icon and replacing only thefa-twitterpart with the new icon likefa-facebookfor example. Then follow the same steps above.
 |
|---|
 |
- Link: Insert the link
href="here"replacing the#. Please refrain from using URL shorteners or URLs that are not from the site you are posting! - Title: Write a brief description
title="here". - Name: Write the resource's name in the text field
>here</a>. - Make sure you have saved all your changes.
- Test your changes. THIS IS IMPORTANT! Open the html file in your browser (by double clicking on it for example) and see what your card will look like on the site. See that the entire page still looks the same and nothing is broken. Click your links and make sure they are working. Open the console (Ctrl + Shift + J (Windows / Linux) or Cmd + Opt + J (Mac)) and check that there are no error messages.
- Great, you have finished editing your code! The next steps will send your changes to GitHub and then submit them to be merged with the main project.
Step 7: Commit your changes
- Go back to the GitHub desktop app.
- Your changes will have been added automatically to the staging area.
- This means that Git has recorded all the saved changes.
- You can see this reflected in the app. Everything you have added to the file will be in green, and deletions will show as red.
 |
|---|
Commit. This roughly means confirm the changes |
 |
Current repository, Your Current branch will have the name you gave it in step 3 |
 |
Commit you must fill in the Summary field. This is the commit message explaining what you have changed. In this case "Add my card information" would be a reasonable message. Optionally you can add a more detailed Description. Click the Commit button. Your button will say something like Commit to "your-branch-name" |
Step 8: Push your changes to GitHub
- Your changes are now saved or committed. But they are saved only locally, that is on your computer.
- Synchronizing local changes with your repository on GitHub is called a Push. You are "pushing" the changes from your local repository to the remote repository on GitHub.
Push button |
 |
|---|
- After a few seconds the operation is complete and now you have exactly the same copy of this branch on your machine as well as on GitHub.
Step 9: Submit a PR(Pull Request)
- This is the moment you have been waiting for; submitting a Pull Request (PR).
- So far all the work you have done has been on the fork of the project, which as you remember resides on your own account of GitHub.
- Now it's time to send your changes to the main project to be merged with it.
- This is called a Pull Request because you are asking the original project maintainer to "pull" your changes into their project.
- Go to the main page of your fork on GitHub (it will have the fork icon and your own user name at the top).
- Towards the top of the repo you will see a highlighted pull request message with a green button.
 |
|---|
Compare and pull request |
 |
Open a pull request page looks like. |
- REMEMBER you are trying to merge your branch with the original project not with the
Masterbranch on your fork. - The image below gives you an idea of how the header of your pull request should look like.
- On the left is the original project, followed by the master branch. On the right is your fork and the branch you created.
 |
|---|
Create pull request |
- Don't be fazed by all the options. You only need to do these three steps for now.
- Leave the option
Allow edits from maintainersticked. - Now, a Pull Request will be sent to the project maintainer. As soon as it is reviewed and accepted your changes will appear on the project web page.
Step 10: Celebrate
That's it. You have done it! You have now contributed to open source on GitHub.
You have added code to a live web page: https://syknapse.github.io/Contribute-To-This-Project
Your changes won't be visible immediately; first they have to be reviewed, accepted, and merged by the project maintainer. Once they are merged your card should be visible and live on the page.
It is very normal for a reviewer to ask for changes on a PR. Think of it as good practice if it happens to you. Keep an eye for comments and requested changes. Once you make the requested changes (back in your branch) all you have to do is to commit and push your changes. The PR will automatically update with the new changes.
I promise I will try to review and merge as soon as possible but I do this in my spare time, so a few days delay is inevitable.
Next Steps
- Come back in a while to check for your merged Pull Request.
- You should receive an email from GitHub when your changes have been approved, or if additional changes are requested. And when the PR is finally merged with the master and your card has been added.
- You can also learn how to contribute from this free series: How to Contribute to an Open Source Project on GitHub
- If you found this project useful please give it a
β starβ at the top of the page and Tweet about it to help spread the word - You can follow me and get in touch on Twitter or using any of these other options
- This is an open source project so apart from contributing your card you are welcome to help fix bugs, improvements, or new features. Open an issue or send a new pull request
- To help improve our community take a look at the GitHub Discussions tab located next to Pull Requests. This area is a place to introduce yourself, go into deeper discussions on Open Source, and communicate with the Project Maintainers. Will you help us build out this feature and enhance our community?
- Thanks for contributing to this project. Now you can go ahead and try contributing to other projects; look for the
label for beginner-friendly contribution options. - I'm also looking for collaborators to give me a hand in reviewing and merging PRs. If you would like to get more advanced Git practice please send me a DM on Twitter and read the maintainer's guide.
Acknowledgements
This project is heavily influenced by Roshan Jossey's great first-contributions project with its excellent tutorial.
It is also particularly inspired by the great community around #GoogleUdacityScholars The Google Challenge Scholarship: Front-End Web Dev, class of 2017 Europe.