33 lines (24 loc) · 1.09 KB

Contributing to wcheck

Thank you for your interest in improving wcheck! We welcome contributions from the community.

Project Structure

cmd/: CLI command definitions (Cobra).
internal/engine/: Core headless browser logic and interaction monkey.
internal/crawler/: Link discovery and site scouting.
internal/reporter/: Pretty CLI reporting and table generation.
tests/: Integration tests for scanner logic.

Workflow

Fork and Clone: Create a feature branch.
Go Version: Ensure you are using Go 1.23+.
Run Tests: Always verify your changes before submitting:
```
go test ./... -v
go test ./tests/... -v
```
Linting: Follow standard Go idioms (gofmt).
Submit PR: Provide a clear description of the fix or feature.

Development Tips

Use the --verbose flag when debugging interaction monkey logic.
Use httptest for mocking web servers in new tests.
Always check for potential race conditions when modifying parallel worker logic.

Feedback

Found a bug or have a feature request? Please open an issue on GitHub.