Contributing

Contribute to Notiky on GitHub — clone the repo, run the local dev environment with make, open pull requests, and find architecture specs and guides.

We welcome contributions. This page is a short overview — full details live in the engineering repo.

Quick start (developers)

git clone https://github.com/notiky/notiky.git
cd notiky
cp .env.example .env
make dev

make dev is the primary local workflow (setup + backend + frontend).

Alternative explicit steps: make setup-main then make start-main.

Pull requests

1. Fork github.com/notiky/notiky
2. Branch from main, make changes with tests where applicable
3. Run make check before opening a PR

Full guide: CONTRIBUTING.md on GitHub

Architecture and specs

Engineering documentation (ADRs, master-plan, runbooks) lives in the monorepo under docs/ — not duplicated here. Browse on GitHub when you need implementation detail.

Support

• Product: [e-mail]
• Bugs: GitHub Issues