Skip to content

docs: add community guidelines (contributing, code of conduct, security)#226

Merged
SebastienMelki merged 6 commits into
mainfrom
docs/community-guidelines
Feb 22, 2026
Merged

docs: add community guidelines (contributing, code of conduct, security)#226
SebastienMelki merged 6 commits into
mainfrom
docs/community-guidelines

Conversation

@SebastienMelki

@SebastienMelki SebastienMelki commented Feb 22, 2026

Copy link
Copy Markdown
Collaborator

Summary

Adds the three standard community health files for the open-source project:

  • CONTRIBUTING.md — comprehensive contributor guide covering:

    • Architecture overview (Vanilla TS, Sebuf RPC, MapLibre + deck.gl, variants, Tauri desktop)
    • Full directory structure reference
    • Development setup using make install and variant-specific dev commands
    • AI-assisted development policy (AI welcome, same quality bar, all code scrutinized equally)
    • Working with Sebuf — how the RPC framework works, adding methods, proto conventions, codegen
    • Step-by-step guides for adding data sources and RSS feeds
    • Coding standards and file organization
    • PR process with conventional commit titles
  • CODE_OF_CONDUCT.md — Contributor Covenant v2.1 adapted for World Monitor

  • SECURITY.md — responsible disclosure policy with:

    • Private vulnerability reporting via GitHub Security Advisories
    • Security considerations for edge functions, sebuf handlers, API keys, and client-side code
    • In-scope / out-of-scope definitions
    • Contributor security best practices

Test plan

  • Verify all internal links in CONTRIBUTING.md resolve correctly
  • Verify make help output matches the referenced make targets
  • Confirm GitHub recognizes the community health files (Settings → Community profile)

🤖 Generated with Claude Code

… and security policy

Add three community health files for the open-source project:

- CONTRIBUTING.md: comprehensive guide covering architecture overview (sebuf,
  variants, directory structure), development setup with make commands,
  AI-assisted development policy, sebuf RPC workflow, data source and RSS
  feed contribution guides, coding standards, and PR process
- CODE_OF_CONDUCT.md: Contributor Covenant v2.1 adapted for World Monitor
- SECURITY.md: responsible disclosure policy, security considerations for
  edge functions/sebuf handlers, and contributor best practices

Co-Authored-By: Claude Opus 4.6 <[email protected]>
@SebastienMelki SebastienMelki added documentation Improvements or additions to documentation community Community contribution claude Generated with Claude Code labels Feb 22, 2026
@vercel

vercel Bot commented Feb 22, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

3 Skipped Deployments
Project Deployment Actions Updated (UTC)
worldmonitor Ignored Ignored Preview Feb 22, 2026 11:34am
worldmonitor-finance Ignored Ignored Preview Feb 22, 2026 11:34am
worldmonitor-startup Ignored Ignored Preview Feb 22, 2026 11:34am

Request Review

@vercel

vercel Bot commented Feb 22, 2026

Copy link
Copy Markdown

Deployment failed with the following error:

The `vercel.json` schema validation failed with the following message: `ignoreCommand` should NOT be longer than 256 characters

Learn More: https://vercel.com/docs/concepts/projects/project-configuration

koala73 pushed a commit that referenced this pull request Feb 22, 2026
Review covers factual inaccuracies (locale count, domain count),
integration gaps with existing docs, and security reporting
contradiction between CODE_OF_CONDUCT.md and SECURITY.md.

https://claude.ai/code/session_014WAfqW8Q189Mq34uBM7UNh
@SebastienMelki
SebastienMelki merged commit dd2877b into main Feb 22, 2026
5 checks passed
@koala73
koala73 deleted the docs/community-guidelines branch February 25, 2026 08:01
facusturla pushed a commit to facusturla/worldmonitor that referenced this pull request Feb 27, 2026
…ty) (koala73#226)

* docs: add community guidelines — contributing guide, code of conduct, and security policy

Add three community health files for the open-source project:

- CONTRIBUTING.md: comprehensive guide covering architecture overview (sebuf,
  variants, directory structure), development setup with make commands,
  AI-assisted development policy, sebuf RPC workflow, data source and RSS
  feed contribution guides, coding standards, and PR process
- CODE_OF_CONDUCT.md: Contributor Covenant v2.1 adapted for World Monitor
- SECURITY.md: responsible disclosure policy, security considerations for
  edge functions/sebuf handlers, and contributor best practices

Co-Authored-By: Claude Opus 4.6 <[email protected]>

* fix: add missing blank line before list in CONTRIBUTING.md (MD032)

Co-Authored-By: Claude Opus 4.6 <[email protected]>

* docs: expand AI section with LLM label attribution and rationale

Co-Authored-By: Claude Opus 4.6 <[email protected]>

* docs: remove GitHub link from AI section

Co-Authored-By: Claude Opus 4.6 <[email protected]>

* docs: simplify AI section back to concise version with PR labels

Co-Authored-By: Claude Opus 4.6 <[email protected]>

---------

Co-authored-by: Claude Opus 4.6 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

claude Generated with Claude Code community Community contribution documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants