Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
42 lines (30 loc) · 1.1 KB

CONTRIBUTING.md

File metadata and controls

42 lines (30 loc) · 1.1 KB
Raw

Contributing to Localforge 🤘

Thanks for taking the time to improve the project!
Localforge only gets better when smart folks like you open issues, file PRs, and share feedback.

Table of Contents

  1. Ground Rules
  2. Getting Set Up
  3. Workflow: Issues → PRs
  4. Coding Standards
  5. Commit & PR Style
  6. Testing
  7. Developer Certificate of Origin (DCO)
  8. Code of Conduct
  9. Need Help?

Ground Rules

  • Search first – duplicates create noise.
  • Small, focused PRs beat giant mega‑changes.
  • Performance wins are great; readability wins are better.
  • Be decent humans – no harassment, no politics flame‑wars. (See Code of Conduct.)

Getting Set Up

# Clone your fork (replace USERNAME)
git clone https://github.com/rockbite/localforge.git
cd localforge

# Install deps
npm install        

# Run the dev build
npm run server            # starts UI + API on localhost:PORT (from env)