From fedb2ffbb826c5863ba0bf40df8041df432d0e1a Mon Sep 17 00:00:00 2001 From: Shashwat Jha Date: Fri, 17 Jul 2026 14:05:53 +0530 Subject: [PATCH 1/7] Update contributing guidelines and add quick start section --- README.md | 35 +++++++++++++++++++++++++++-------- 1 file changed, 27 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index b764247..9c15a55 100644 --- a/README.md +++ b/README.md @@ -33,14 +33,33 @@ This repo includes `.github/workflows/deploy.yml` to deploy from `main` to GitHu 2. Set **Build and deployment** source to **GitHub Actions**. 3. Push changes to `main`; deployment runs automatically. -## Contribution workflow - -1. Pick or claim an issue from the Issues tab. -2. Create a branch from `main`. -3. Make small, focused changes. -4. Open a pull request using the PR template. -5. A mentor reviews and approves your pull request. -6. The maintainer merges it after mentor approval. +## Contributing + +New here? Read this section before opening an issue or PR — it covers the full path from "I want to help" to "my change is merged." + +### Quick start (first-time contributors) + +1. Read [`CONTRIBUTING.md`](.github/CONTRIBUTING.md) for coding conventions, accessibility standards, and testing steps. +2. Fork the repo (or clone directly if you have write access) and follow [Local setup](#local-setup-no-build-tools) above. +3. Browse [open issues](../../issues) and look for the [`good first issue`](../../issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) label if this is your first contribution. +4. Comment on the issue to claim it before starting work, so two people don't duplicate effort. + +### Workflow + +1. Pick or claim an issue from the Issues tab. If no issue exists for what you want to change, [open one first](../../issues/new/choose) using the appropriate template — this keeps work visible and avoids duplicated effort. +2. Create a branch from `main` (e.g. `git checkout -b fix/gallery-alt-text`). +3. Make small, focused changes that match the issue's scope. Prefer several small PRs over one large one. +4. Test locally per [`CONTRIBUTING.md`](.github/CONTRIBUTING.md#testing-your-change) — open the affected pages in a browser and check keyboard navigation. +5. Open a pull request using the PR template, and complete every checklist item (or explain why an item doesn't apply). +6. Link the PR to its issue (`Closes #123`) so it closes automatically on merge. +7. A mentor reviews and approves your pull request; respond to review comments with follow-up commits rather than force-pushing over history. +8. The maintainer merges it after mentor approval, and GitHub Pages deploys automatically from `main`. + +### Getting help + +- Unsure where to start? Ask in the issue you're interested in — a mentor will point you in the right direction. +- Found a bug but don't have time to fix it? [File a bug report](../../issues/new?template=bug-report.yml) instead of leaving it undocumented. +- Stuck mid-PR? Open it as a draft and describe what you're blocked on; reviewers can jump in before it's finished. ## Yearly update checklist From 7f8e8dc4aa538b1b5143b2cd4f6e5854e1f51559 Mon Sep 17 00:00:00 2001 From: Shashwat Jha Date: Fri, 17 Jul 2026 14:07:01 +0530 Subject: [PATCH 2/7] Create CONTRIBUTING.md with contribution guidelines Added contributing guidelines for the project, including setup instructions, coding conventions, accessibility standards, and testing procedures. --- .github/CONTRIBUTING.md | 50 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 .github/CONTRIBUTING.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..c18a86b --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,50 @@ +# Contributing to Contributor Catalyst + +Thanks for helping build this site. It's a plain HTML/CSS/JS project with no build step, so you can go from clone to change in a couple of minutes. + +## Before you start + +- Check the [open issues](../../issues) for something to work on, or open a new one with the right template ([bug](../../issues/new?template=bug-report.yml), [feature](../../issues/new?template=feature-request.yml), [content task](../../issues/new?template=content-task.yml)). +- Comment on the issue to claim it. If it's unclear or under-specified, ask questions there before writing code. +- For anything beyond a typo fix, wait for a mentor to confirm the approach before investing significant time. + +## Setup + +1. Clone the repo: `git clone https://github.com/contributor-catalyst/website.git` +2. Open `index.html` directly in a browser, or serve the folder with any static server (e.g. `python3 -m http.server`). +3. No `npm install`, no build step. Edit HTML/CSS/JS files directly and refresh the browser to see changes. + +## Coding conventions + +- **HTML**: use semantic elements (`