Welcome to your first open source contribution! This project is designed for beginners who want to learn how to contribute to open source projects on GitHub.
This is a simple project where you can add your name to our contributors list. It's a safe place to practice making your first pull request!
Follow these simple steps to add yourself to the contributors list:
Click the "Fork" button at the top right of this page. This creates a copy of the repository in your GitHub account.
Clone the forked repository to your local machine:
git clone https://github.com/YOUR-USERNAME/first-contribution.git
cd first-contributionReplace YOUR-USERNAME with your GitHub username.
Create a new branch for your changes:
git checkout -b add-your-nameReplace your-name with your actual name or GitHub username.
Create a new JSON file in the contributors/ directory with your GitHub username as the filename. For example, if your username is johndoe, create contributors/johndoe.json.
Template:
{
"github": "your-github-username",
"photo": "https://github.com/your-github-username.png",
"quote": "Your favorite quote here"
}Important:
- Create a new file named
contributors/{your-github-username}.json - Replace
your-github-usernamewith your actual GitHub username - The
photofield is optional. If you don't provide it, your GitHub avatar will be used automatically - Make sure your JSON is properly formatted (use the template above)
Example:
If your username is johndoe, create contributors/johndoe.json:
{
"github": "johndoe",
"photo": "https://github.com/johndoe.png",
"quote": "Code is like humor. When you have to explain it, it's bad."
}You can also look at existing files in the contributors/ directory or use contributors/TEMPLATE.json as a reference.
Add and commit your changes:
git add contributors/your-github-username.json
git commit -m "Add YOUR-NAME to contributors"Replace your-github-username with your actual GitHub username.
Push your changes to your forked repository:
git push origin add-your-name- Go to your forked repository on GitHub
- Click on "Compare & pull request" button
- Add a title like "Add [Your Name] to contributors"
- Write a brief description
- Click "Create pull request"
Congratulations! You've just made your first contribution to open source! Your pull request will be reviewed, and once approved, your name will appear on the contributors page.
You can view all contributors at: https://ossphilippines.github.io/first-contribution/
Or open index.html in your browser locally to see the page.
If you run into any issues or have questions, feel free to:
- Check out CONTRIBUTING.md for detailed guidelines
- Open an issue in this repository
- Ask for help in the pull request comments
- Reach out to the community
This project is licensed under the MIT License - see the LICENSE file for details.
Happy Contributing! 🚀