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 (`