Skip to content

Commit 134f831

Browse files
feat: add bug bounty platform integration and checkpoint config restoration
- Added support for bug bounty platform scope validation with new CLI flags (--platform, --program, --scope-validation) - Implemented platform credentials loading from environment variables for HackerOne, Bugcrowd, Intigriti and YesWeHack - Fixed checkpoint restoration to properly recover original scan configuration instead of using CLI flags - Enhanced documentation standards to clarify inline vs standalone docs and token
1 parent e2af5b8 commit 134f831

20 files changed

Lines changed: 5470 additions & 501 deletions

CLAUDE.md

Lines changed: 44 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -757,14 +757,50 @@ shells results search --term "Golden SAML"
757757
- Backend logging: Use `log.Debugw()`, `log.Warnw()`, `log.Errorw()` with component tags
758758
- Progress updates: Use periodic `log.Infow()` with progress_pct field
759759
- Interactive prompts: Log intent before/after using structured logging
760-
- **ALL documentation must be inline in code files** (ENFORCED):
761-
- Strategic documentation: Header comments in relevant package/file
762-
- Tactical notes: Inline comments at exact location in code
763-
- Architecture decisions: Document in main package file (e.g., pkg/hera/hera.go)
764-
- Fix summaries: Inline with ADVERSARIAL REVIEW STATUS blocks
765-
- NEVER create standalone .md files for fix summaries, architecture docs, implementation status, or code review results
766-
- ONLY create standalone .md for: README.md, CLAUDE.md, CONTRIBUTING.md
767-
- When asked to document work, default to inline comments in code
760+
761+
### Documentation Standards (ENFORCED - SAVE TOKENS)
762+
763+
**CRITICAL: Documentation is expensive. Minimize wasteful .md file creation.**
764+
765+
**Inline Documentation ONLY** (99% of cases):
766+
- Strategic documentation: Header comments in relevant package/file
767+
- Tactical notes: Inline comments at exact location in code
768+
- Architecture decisions: Document in main package file header (e.g., pkg/hera/hera.go)
769+
- Fix summaries: Inline with ADVERSARIAL REVIEW STATUS blocks in affected files
770+
- Implementation notes: Inline comments where code lives
771+
- API documentation: godoc comments on exported functions/types
772+
773+
**ROADMAP.md for Planning** (use for plans and future work):
774+
- Feature roadmap and future enhancements
775+
- Multi-step implementation plans
776+
- Strategic priorities and timelines
777+
- Deferred work and technical debt backlog
778+
- Breaking changes planned for future versions
779+
780+
**Standalone .md Files** (ONLY these three):
781+
- README.md - User-facing project documentation
782+
- CLAUDE.md - This file, instructions for Claude Code
783+
- CONTRIBUTING.md - Contribution guidelines (if it exists)
784+
785+
**NEVER create standalone .md files for:**
786+
- Fix summaries or work logs
787+
- Architecture documentation
788+
- Implementation status or progress reports
789+
- Code review results
790+
- Analysis or investigation notes
791+
- Feature documentation
792+
- API documentation
793+
794+
**When asked to "document" something:**
795+
1. Default to inline code comments
796+
2. If planning future work, add to ROADMAP.md
797+
3. Only create new .md files if explicitly required AND user confirms
798+
799+
**Token Cost Reality:**
800+
- Reading large .md files costs 1000s of tokens
801+
- Inline docs are read with code (already loaded)
802+
- ROADMAP.md is small, scoped, efficient
803+
- Every unnecessary .md file wastes user's API budget
768804

769805
### Priority System
770806

0 commit comments

Comments
 (0)