Skip to content

Add contributor and security documentation #25

Description

@ashishsinghbora

Problem Statement

New contributors currently need to understand the project architecture and safety requirements before making changes.

Security reporting also needs a clear process.

Proposed Solution / Enhancement

Add:

  • CONTRIBUTING.md
  • SECURITY.md

CONTRIBUTING.md should explain:

  • Project architecture
  • Development setup
  • Running tests
  • Writing tests
  • Pull request expectations
  • Coding conventions

SECURITY.md should explain:

  • How to report security issues
  • What information should be included
  • What should not be publicly disclosed

Architectural Layer Impacted

Documentation / Open Source / Security

Alternatives Considered

Leaving contributor and security guidance undocumented increases onboarding time and can result in unsafe public disclosure of vulnerabilities.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationphase:releasePhase: CI, release and documentation

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions