Accepting PRs till 31st Oct
A tiny, friendly GitHub Pages site for first-time contributors to make their very first pull request. Add your name and GitHub link to a simple data file, open a PR, and see yourself appear on the live website
please Note: This repository might not be eligible for hactoberfest 2025, but this is a solid one to get started and give you confidence
See yourself: https://rohit-554.github.io/FirstLeaf/
https://github.com/Rohit-554/FirstLeaf/tree/master/.github/ISSUE_TEMPLATE
This repo powers a static site hosted on GitHub Pages. The page reads a newline-delimited JSON (NDJSON) file and renders a grid of contributors. Beginners only need to edit one line to add themselves.
- No frameworks required
- No build step
- Just HTML, CSS, and a little JS
- Fork this repository to your own GitHub account.
- Create a new branch for your change, e.g.
add/your-name
. - Edit
data/contributors.ndjson
and add a new line following the format below. - Commit your change with a helpful message and push the branch.
- Open a Pull Request. Once merged, your profile will appear on the site.
One JSON object per line. Do not remove other lines. Do not add trailing commas. Keep it simple.
Required fields:
name
: Your display nameusername
: Your GitHub username (no@
)
Optional fields:
github
: Full URL to your profile (defaults tohttps://github.com/<username>
if omitted)message
: A short message that appears on your cardaddedAt
: ISO date string (we will add or adjust this during review if you omit it)avatar
: A custom avatar URL (defaults to your GitHub avatar)
Example line to copy and edit (add it as a new line at the end of the file):
{"name":"Ada Lovelace","username":"ada","github":"https://github.com/ada","message":"Hello, world!","addedAt":"2025-09-30T12:00:00.000Z"}
Tip: Use an online JSON formatter if you are unsure. Remember, each line must be a valid JSON object.
You can open index.html
directly in your browser. Some browsers block fetch
from file://
URLs. If that happens, run a tiny web server and open http://localhost:8080
.
On Windows (PowerShell):
# Python 3
python -m http.server 8080
Then visit http://localhost:8080 in your browser and click index.html
.
- Go to Settings → Pages in your fork or the main repo.
- Set Source to
Deploy from a branch
and pick branchmain
(orgh-pages
if you prefer). - Set folder to
/ (root)
and save. - Your site will be available at
https://<your-username>.github.io/sicksticks
.
.
├── index.html # Main page
├── assets/
│ ├── styles.css # Styling
│ └── app.js # Fetch and render contributors
├── data/
│ └── contributors.ndjson # One JSON object per line
├── scripts/
│ ├── validate-contributors.js # Validates contributors data
│ └── update-readme-contributors.js # Updates README contributors section
└── README.md
Note: The contributors section at the bottom of this README is automatically updated by a GitHub Action whenever a PR is merged to the main branch.
Be kind, be patient, and be respectful. This is a beginner-friendly space.
- You! PRs welcome.
MIT License. See LICENSE
.
Thank you to all the amazing contributors who have helped make this project better! 🎉