GitHub repository templates and configuration. Activate when setting up GitHub repos, CONTRIBUTING.md, CODEOWNERS, issue templates, PR templates, or GitHub Copilot instructions.
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.
Guidelines for GitHub repository configuration and community files.
| File | Purpose | Required |
|---|---|---|
| README.md | Project overview | MUST |
| LICENSE | Legal terms | MUST for open source |
| CONTRIBUTING.md | Contribution guidelines | SHOULD |
| CODE_OF_CONDUCT.md | Community standards | SHOULD |
| SECURITY.md | Vulnerability reporting | MUST for public repos |
| CODEOWNERS | Review assignments | RECOMMENDED |
| .github/copilot-instructions.md | AI coding assistant context |
| RECOMMENDED |
Place in .github/ISSUE_TEMPLATE/. Use YAML form format for structured input.
Key elements for bug_report.yml:
Key elements for feature_request.yml:
Add config.yml to disable blank issues and add contact links.
See assets/bug_report.yml.template for full example.
Place at .github/pull_request_template.md.
## Summary
<!-- Brief description of changes -->
## Type of Change
- [ ] Bug fix
- [ ] New feature
- [ ] Breaking change
- [ ] Documentation update
## Testing
<!-- How was this tested? -->
## Checklist
- [ ] Tests pass locally
- [ ] Documentation updated
- [ ] No breaking changes (or documented)
Place at .github/CODEOWNERS or CODEOWNERS in root.
# Default owners
* @org/team-leads
# Directory ownership
/src/ @org/developers
/docs/ @org/tech-writers
# File patterns
*.js @org/frontend-team
*.py @org/backend-team
# Specific files
/config/prod.yml @org/devops @security-lead
Rules:
@org/team) over individuals when possibleRecommended settings for main/master:
Place workflows in .github/workflows/.