Contributing
Pull Request Process
- Fork the repository and create a feature branch
- Make your changes following the coding standards
- Ensure TypeScript compiles:
npm run buildin both frontend and backend - Run tests:
npm testin the relevant directory - Create a PR with a clear description
- 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 typefor type-only imports - Satisfy
noUnusedLocals/noUnusedParameters
Naming Conventions
| Type | Convention | Example |
|---|---|---|
| Component files | PascalCase | TestDetailPage.tsx |
| Utility files | camelCase | metadataExtractor.ts |
| Route files | kebab-case | browser.routes.ts |
| Components | PascalCase | SecurityTestCard |
| Functions | camelCase | fetchTestResults |
| Constants | UPPER_SNAKE_CASE | MAX_RETRY_ATTEMPTS |
| Go packages | lowercase | executor, sysinfo |
Questions?
Open a GitHub issue with the "question" label or start a Discussion.