🚀 Let’s Contribute to Open Source!
Welcome to the Good First Issue repository! This project aims to provide a platform for beginners to make their first contributions to open source.
This repository is designed to help you get started with open source contributions. It provides a friendly environment where you can learn and grow as a developer.
The index.json file is an essential part of the Good First Issue project. It contains the data used to generate the cards displayed on the webpage. Follow the steps below to contribute to the index.json file:
Fork the repository: Click on the "Fork" button at the top right corner of the repository page to create a fork in your GitHub account.
Clone the repository: On your local machine, navigate to the directory where you want to store the project. Use the following command to clone the repository:
git clone https://github.com/your-username/good-first-issue.git
Create a new branch: Move into the project's directory and create a new branch to work on your changes:
cd good-first-issue
git checkout -b add-new-contributor
Make your changes: Open the index.json file in a text editor. Add your contribution to the file using the following format:
{ "name": "Your Name" }The name field is mandatory and should include your name or preferred username.
The link field is optional and can include a link to your portfolio website or GitHub profile.
The style field is optional and allows you to customize the appearance of your card. Provide a valid CSS style object to modify the background color, text color, etc.
The dark field is optional and allows you to customize the appearance of your card in dark mode. Provide a valid CSS style object to modify the background color, text color, etc.
Save your changes: Once you've made your additions to the index.json file, save the file.
Commit and push: Use the following commands to commit your changes and push them to your forked repository:
git add index.json
git commit -m "Add new contributor to index.json"
git push origin add-new-contributor
Create a pull request: Go to the original repository on GitHub and click on the "New Pull Request" button. Provide a descriptive title and explanation of your changes, then submit the pull request.
Open your terminal and run the following command to start a local server:
npx http-server
This will start a local server. Open your preferred web browser and enter the following URL in the address bar:
http://localhost:8080
You will be taken to the webpage where your contribution will be displayed.
To access the live site, click the following link. Explore and enjoy!
Congratulations! You've successfully contributed to the index.json file. Your changes will be reviewed, and if everything looks good, they will be merged into the main repository.
We appreciate your contribution to the Good First Issue project!
Happy contributing! 🚀