practices

This repository contains org-level software engineering practices for RMI. It defines shared principles, process expectations, architecture guidance, security expectations, and reusable templates.

What Lives Here

• Organization-wide standards and guidance that apply across repositories.
• Shared templates and reference documents.
• Cross-cutting expectations for maintainers and contributors.

How To Adopt

This guidance is for all contributors. Repository maintainers are accountable for operationalizing it in each repository.

• Start with the Table of Contents below to find the guidance most relevant to your work.

How This Repo Relates to .github

• This repo is the source of truth for guidance: the “why” and “how” behind our engineering standards.
• .github is the operational surface: templates and defaults GitHub picks up automatically when a repo doesn’t override them.

Table of Contents

Principles

• Repository Maintainer Guidelines

Process

• Git
• Pull Requests
• Software Versioning
• OKRs
• Agile Overview
• Agile Ceremonies
• Jira Runbook

Architecture

• Default Web Application Stack
• API design principles (planned)
• Testing philosophy (planned)
• Observability guidance (planned)

Security

• Secrets handling (planned)
• Vulnerability disclosure expectations (planned)

Templates

• PRD Template

Meta

• Maturity model (planned)
• Glossary (planned)

Compatibility Notes

Legacy root paths (git.md, pull_request.md, maintainer.md, version.md, prd_template.md) are preserved as compatibility links to their new locations.

Related Resources

• Resources