If you're new to GitHub and open source, you're in the right place! This repository is designed to help you get started with your open source journey. You'll learn how to make your first contribution by adding your name and a small piece of information about yourself to a tiny file.
Before you begin, make sure you have the following:
- A GitHub account (if you don't have one, you can sign up here)
- Basic knowledge of Git and GitHub (you can learn the basics here)
- A text editor or code editor of your choice
-
Star the Repo -> ⭐. It will help others find the project.
-
Fork the Repository: Click the "Fork" button at the top right corner of this repository to create your own copy.
-
Clone Your Fork: Clone your forked repository to your local machine:
git clone https://github.com/ossguild/Nametaker.git
-
Edit
contributors.js: Open thecontributors.jsfile and add your name and a brief description about yourself in the following format:
{
name: 'Joshua Omobola',
emoji: '🌵',
favoriteQuote: 'I believe in unicorns',
twitterUrl: 'https://twitter.com/kohawithstuff',
},- Commit Your Changes: Save your changes, commit them, and push to your GitHub repository:
git add *
git commit -m "feat: Add [Your Name] to contributors"
git push origin main-
Create a Pull Request: Go back to the original repository on GitHub. You should see a notification prompting you to create a pull request. Click it, and submit your changes.
-
Wait for Approval: Once you've submitted your pull request, our team will review your contribution. If everything looks good, your changes will be merged into the main repository.
Important Note: Do not make any changes to the index.html file in this repository. This file is here as a part of the project and should remain untouched by contributors.
- Install Node.js: If you don't have Node.js and npm installed, download it here. If you using Linux, from your terminal, run
sudo apt update
sudo apt install nodejs
sudo apt install npm- Install project dependencies: In your project directory, from your terminal, run:
npm install- Start the development server:
npm run devOpen your web browser and visit http://localhost:5173 to see your contributions in action.
GitHub Learning Lab: A great resource for learning GitHub interactively.
How to Create a Pull Request on GitHub: Detailed guide on creating pull requests. We're excited to have you on board! Happy contributing! 🚀
This project is licensed under the MIT License - see the LICENSE file for details.