Logo Created with 💖 By CandidDeer
Would you like to become a maintainer on this project? Read the maintainer's guide, join our Discord server, and request to join the team.
- Introduction
- Who is this for?
- What am I going to contribute?
- Translations
- Setup
- Contribute
- Next Steps
This is the terminal version of the tutorial. Everything here uses Git on the command line. If you prefer a GUI, use GitHub Desktop instead.
Anyone comfortable enough with a terminal to run basic Git commands. You don't need to be an expert — if you can navigate directories and run commands, you're good.
You'll add a personal card to the project's web page. It will include your name, contact links, a short description, and links to developer resources you recommend.
This tutorial is also available in other languages. Note that translations may lag behind the English version.
| Bengali | German | Hindi | Korean |
|---|---|---|---|
| Portuguese (BR) | Spanish | Telugu | Ukrainian |
Translations for this tutorial are welcome. See CONTRIBUTING.md to get started.
Make sure you have Git installed:
git --versionIf you don't have it, download Git here.
Become an open source contributor in 10 steps.
Fork this project by clicking the Fork button at the top right of the repository page. This creates a copy of the project under your own GitHub account.
Clone your fork to your local machine:
git clone https://github.com/your-github-username/Contribute-To-This-Project.gitThen move into the project directory:
cd Contribute-To-This-ProjectCreate and switch to a new branch:
git checkout -b your-name-cardUse a descriptive name — your-name-card is a good convention for this project.
Do NOT work on the master branch.
The project has a ready-made card template in the cards/ folder. Copy it and rename the copy to match your exact GitHub username:
cp cards/template.html cards/your-github-username.htmlFor example, if your username is octocat:
cp cards/template.html cards/octocat.htmlThis is the only file you will be editing. Do not edit cards/template.html itself.
Open your new card file in any editor:
code cards/your-github-username.html # VS Code
# or: nano, vim, etc.Your card looks like this:
<div class="card">
<p class="name">Your name</p>
<p class="contact">
<!-- Add one or more contact links. At minimum, include your GitHub. -->
<i class="fab fa-github"></i>
<a href="https://www.github.com/your_user_handle" target="_blank">Your handle</a>
</p>
<p class="about">Write a sentence or two about yourself.</p>
<div class="resources">
<p>3 Useful Dev Resources</p>
<ul>
<li>
<a href="#" target="_blank" title="First Resource">Resource 1</a>
</li>
<li>
<a href="#" target="_blank" title="Second Resource">Resource 2</a>
</li>
<li>
<a href="#" target="_blank" title="Third Resource">Resource 3</a>
</li>
</ul>
</div>
</div>Fill it in:
- Name — replace
Your namewith your name. Do not changeclass="name". - Contact — replace the GitHub link and handle with your own. Add more contact links if you like — find icon classes at Font Awesome Icons (e.g.
fab fa-linkedin,fab fa-x-twitter). - About — replace the placeholder with a short description of yourself.
- Resources — replace
#with real URLs, updatetitle=""and the link text. These are optional, but if you include them, each needs a real link. Maximum 5.
Do not change any class names or the HTML structure. The validation bot checks for these.
Save the file when you're done.
Open your card file and read through it. Make sure:
- All placeholder text is replaced
- All links start with
https:// - The filename matches your exact GitHub username
The automated check when you submit will catch anything structural you might have missed.
Stage your card file:
git add cards/your-github-username.htmlCommit with a short message:
git commit -m "Add my card"Push your branch to your fork:
git push origin your-name-cardGo to your fork on GitHub. You'll see a prompt to open a pull request for your recently pushed branch — click Compare & pull request.
Make sure the base repository is Syknapse/Contribute-To-This-Project and the base branch is master.
Leave Allow edits from maintainers checked, then click Create pull request.
A bot will automatically validate your card. If everything looks good it merges it automatically. If something needs fixing, the bot will leave a comment explaining exactly what to change — push the fix to the same branch and it will re-check.
You've made your first open source contribution! Your card will be live at https://syknapse.github.io/Contribute-To-This-Project shortly after merging.
Where did my HTML file go? After a while, submitted cards are automatically archived to keep the repository lightweight. Your file is removed from cards/ but its data is preserved in the archive and your card still appears on the site. Find out more.
- 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
- Join our Discord server
- Want to contribute beyond a card? See CONTRIBUTING.md for the full guide.
- Thanks for contributing! Now try contributing to other projects — look for the
label for beginner-friendly options.
This project is heavily influenced by Roshan Jossey's great first-contributions project.