How thorcollective/hearth works
Main Components
• Hunt Categories:
• Flames (Hypothesis-driven hunts)
• Embers (Environment baselining and exploratory analysis)
• Alchemy (Model-assisted and algorithmic approaches)
• Supporting/Collaboration Areas:
• Forge: A space for early-stage hunt ideas and development.
• Kindling: Contains templates, guides (e.g., Hunt-Generation, Hunt-Review), and additional resources.
• Keepers: Guidelines, contribution process documentation, review-process details, and community standards.
• Assets: Contains the images, logos, and other static resources used in the repository.
• GitHub Configurations: The .github directory holds issue templates and workflows for tasks like labeling issues and static code analysis, showcasing integration with CI/CD pipelines to support contributions.
Interactions and Flows
• Contribution Flow:
• Users submit hunt ideas (via issues or pull requests) through the GitHub submission system.
• The GitHub workflows (defined under .github/workflows) automatically process submissions (for example, labeling or static checks).
• Reviewed submissions eventually become part of one of the hunt type directories (Flames, Embers, or Alchemy) or are iterated further in Forge.
• The review and refinement process is detailed in the Keepers and Kindling directories.
• Organizational Flow:
Architectural Patterns and Design Principles
• Separation of Concerns: The repository is neatly divided into directories, each with a clear responsibility—content focus (the three hunt categories), early development (Forge), resources/templates (Kindling), and governance (Keepers).
• Workflow Automation: Highlight the integration with GitHub Actions (issue-labeler and static analysis workflows) which help automate part of the review and contribution process.
• Community-Centric Design: The structure emphasizes collaboration, documentation, and feedback channels.