Contributing

Contributing

Thanks for helping! Contributions of every size are welcome, from typo fixes to new features.

Set up in five minutes

Requirements: Node.js 20.9+ and pnpm 9+.

git clone https://github.com/praneeth132006/ForkLeaf.git
cd ForkLeaf
pnpm install
pnpm dev

Open http://localhost:3000/editor. With no configuration ForkLeaf runs in local mode, fully working, with notes in your browser.

Before you open a pull request

pnpm check   # formatting, typecheck, lint, tests and build

• Branch from main and open a pull request against main.
• Pull requests are squash-merged, and CI must pass first.
• Add tests for new logic, and explain why in comments for anything non-obvious.

Where to start

• Issues labelled good first issue
• Ideas in Discussions
• The full guide: CONTRIBUTING.md
• How the code fits together: docs/architecture.md

Please follow the Code of Conduct. Security issues go through SECURITY.md, never public issues.