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

4.3 README Files

Jump to bottom
David Samuel edited this page Nov 16, 2023 · 3 revisions

The Policy

All repositories should include a README file that provides an overview of the project, installation instructions, and usage guidelines. Markdown formatting is encouraged for clarity.

Implementation

For example README.md

  • README.md should be in capitals

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