Skip to content

docs: contribution guide + 5 good-first-issues#109

Merged
sepehr-safari merged 1 commit into
mainfrom
docs/contribution-guide
Jul 9, 2026
Merged

docs: contribution guide + 5 good-first-issues#109
sepehr-safari merged 1 commit into
mainfrom
docs/contribution-guide

Conversation

@sepehr-safari

Copy link
Copy Markdown
Member

Summary

Expands CONTRIBUTING.md with:

  • Architecture Overview — core data flow diagram, key modules table, browser-safe vs Node-only
  • Testing Guide — how to run tests, writing tests, test patterns
  • Contributing Scenarios — step-by-step guide for adding a new scenario
  • Contributing Detection Rules — step-by-step guide for adding a new failure rule
  • Good-First-Issue Workflow — guidance for new contributors

Also creates 5 good-first-issues on GitHub (#104#108):

Closes #90

Checklist

  • CONTRIBUTING.md expanded with architecture overview, setup guide, code org guide, testing guide, scenario/detection contribution guides
  • 5 good-first-issues created with good-first-issue label
  • Good-first-issues have clear instructions, acceptance criteria, and code pointers
  • No maintainer email in any committed file
  • No changeset needed (docs-only)

@sepehr-safari sepehr-safari merged commit c5e2544 into main Jul 9, 2026
2 checks passed
@sepehr-safari sepehr-safari deleted the docs/contribution-guide branch July 9, 2026 07:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: contribution guide + good-first-issues

1 participant