Guide
Project Structure & Docs
Organise repos with clear folders, READMEs, and contribution notes so collaborators can ship quickly.
Start With Structure: Use a simple layout: src/ for code, tests/ for automated tests, docs/ for diagrams/notes. Keep .env.example for secrets you never commit.
Write a Clear README: Explain what the project does, how to install, how to run, and how to test. Add tech stack, links to demos, and common troubleshooting tips.
Add Contribution Notes: Create CONTRIBUTING with branching rules, commit style, lint/test commands, and PR expectations. Include how to file issues with context.
Licensing: Pick a license early (MIT for permissive personal work is common). Mention it in README and add the LICENSE file.
Changelogs and Releases: For team work, tag releases or keep a CHANGELOG. Note breaking changes and migration steps. Keep installation steps up to date.
Onboarding New Contributors: Add a short checklist: clone, install deps, run tests/lint, create branch, open PR. Mention code style (tabs/spaces, casing) and review etiquette.