Skip to content

docs: add coding guidelines derived from existing patterns #157

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
swarit-stepsecurity wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add coding guidelines derived from existing patterns #157

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,8 @@ Documentation lives in the `docs/` folder. Improvements, corrections, and new gu

## Code Style

See **[docs/coding-guidelines.md](docs/coding-guidelines.md)** for the full coding guidelines — the conventions this codebase already follows (package layout, cross-platform build tags, the data-driven detector pattern, error/resilience handling, the JSON/wire contract, secret redaction, testing, and CI gates). New code (human- or agent-authored) should follow it.

- Go source code in `internal/` must pass `golangci-lint` (our CI runs it on every PR)
- Follow the existing code patterns (package structure, naming conventions, JSON struct tags)
- Use the `progress` package for status messages (they respect the `--verbose` flag)
Expand Down
Loading
Loading