Skip to content
This repository was archived by the owner on Sep 22, 2025. It is now read-only.

4.6 Documentation

Jump to bottom
David Samuel edited this page Feb 12, 2024 · 10 revisions

The Policy

Maintain comprehensive and up-to-date documentation for projects, including usage instructions, installation guides, and troubleshooting tips.

Implementation

  • All guides and instructions should be stored in either
    • docs/ folder as markdown or GitHub Wiki pages.
  • A CONTRIBUTING.md should be the ROOT of the repositary, docs/ or in .github/

home

GitHub Policy

Account and Profile

Managing Movers, Leavers and Joiners

Repository Management

Collaboration and Communication

Security and Compliance

Continuous Integration and Deployment (CI/CD)

Reporting Issues

Compliance and Enforcement

Exceptions Process

Retrospective Implementation

Clone this wiki locally