Skip to main content

Contributing

Pull Request Process

  1. Fork the repository and create a feature branch
  2. Make your changes following the coding standards
  3. Ensure TypeScript compiles: npm run build in both frontend and backend
  4. Run tests: npm test in the relevant directory
  5. Create a PR with a clear description
  6. Address review feedback

PR Requirements

  • Code follows project style guidelines
  • TypeScript compiles without errors
  • Self-review completed
  • No sensitive data or credentials included
  • Go agent compiles (if changed): cd agent && go build ./...

Coding Standards

TypeScript

  • Strict mode enabled; avoid any
  • Use import type for type-only imports
  • Satisfy noUnusedLocals/noUnusedParameters

Naming Conventions

TypeConventionExample
Component filesPascalCaseTestDetailPage.tsx
Utility filescamelCasemetadataExtractor.ts
Route fileskebab-casebrowser.routes.ts
ComponentsPascalCaseSecurityTestCard
FunctionscamelCasefetchTestResults
ConstantsUPPER_SNAKE_CASEMAX_RETRY_ATTEMPTS
Go packageslowercaseexecutor, sysinfo

Questions?

Open a GitHub issue with the "question" label or start a Discussion.