siujamo
9a790e1211
- README with project overview, architecture diagram, and quick start - CONTRIBUTING with development setup and code style guidelines - CHANGELOG starting at 0.1.0 (unreleased, under active development)
1.2 KiB
1.2 KiB
Contributing to Pipely
Thank you for your interest in contributing.
Getting Started
- Fork the repository
- Clone your fork:
git clone git@onixbyte.dev:<your-org>/pipely.git - Create a branch:
git switch -c feature/your-feature
Development
Backend (Go)
go run cmd/server/main.go # run the server
go test ./... # run tests
go vet ./... # lint
Frontend (React)
cd web
pnpm install
pnpm dev # dev server with HMR and API proxy
pnpm build # production build
Code Style
- Go: Standard
gofmtformatting. Rungo fmt ./...before committing. - TypeScript: ESLint + Prettier. Run
pnpm lintbefore committing. - Spelling: British English throughout (e.g.
colour,centre,optimise,artefact). - Commit messages: Follow Conventional Commits.
Pull Requests
- Keep changes focused and minimal
- Ensure
go build ./...andpnpm buildpass - Update documentation if your change affects the API
Reporting Issues
Use the issue tracker. Include:
- Steps to reproduce
- Expected and actual behaviour
- Environment details (Go version, PostgreSQL version, OS)