Skip to content

docs: add community documents (CONTRIBUTING, CODE_OF_CONDUCT, SECURITY)#31

Open
tedteddy wants to merge 1 commit intoomni-door:masterfrom
tedteddy:docs/community-docs
Open

docs: add community documents (CONTRIBUTING, CODE_OF_CONDUCT, SECURITY)#31
tedteddy wants to merge 1 commit intoomni-door:masterfrom
tedteddy:docs/community-docs

Conversation

@tedteddy
Copy link
Copy Markdown
Member

Summary

This PR adds essential community documentation to improve contributor experience and establish community guidelines.

Files Added

  • CONTRIBUTING.md: Contribution guidelines including:

    • How to report bugs
    • How to suggest enhancements
    • Pull request process
    • Development setup
    • Commit message conventions
    • Project structure overview
  • CODE_OF_CONDUCT.md: Contributor Covenant Code of Conduct v2.1

    • Defines expected behavior
    • Outlines unacceptable behavior
    • Provides enforcement guidelines
  • SECURITY.md: Security policy including:

    • Supported versions
    • How to report vulnerabilities
    • Response timeline
    • Disclosure policy

Why

These documents are essential for open source projects to:

  • Lower the barrier for new contributors
  • Establish clear community standards
  • Provide a safe reporting channel for security issues

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.

1 participant