FIRST PR is a beginner-friendly open-source project that aims to introduce newcomers to the world of open source development. You can contribute to this project by adding your own README.md file, which will be displayed on our website.
Make sure you have the following prerequisites installed on your operating system before you start contributing:
-
To verify run:
node -v
npm -v
-
Fork this Repository.
Click the "Fork" button at the top right of this repository to create your copy.
-
Clone your Fork.
git clone https://github.com/your-username/FIRST-PR.git cd FIRSTPR
-
Create a New Branch.
Create a new branch to work on your contribution.
git checkout -b my-contribution
Install the dependencies for running the site.
npm install
Now run the site at your local server
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
Open http://localhost:3000 with your browser to see the result.
-
Add your README.md./ Blog
Inside the content directory, create a new .md file with your GitHub username (e.g., your-username.md)
-
Commit and Push.
git add . git commit -m "Add my README.md" git push origin my-contribution
Commit your changes and push them to your forked repository.
-
Create a Pull Request.
Go to your forked repository on GitHub, and you should see a "New Pull Request" button. Click on it and submit your pull request.
Wait for Approval.
7 Our maintainers will review your pull request. Once it's approved and merged, your README.md will be displayed on our website.