Skip to content
9 changes: 9 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,15 @@

Describe the change, scope, validation, compatibility, migration, and safety impact.

## Documentation architecture

- [ ] I identified one primary audience and used the required page frontmatter.
- [ ] Exact commands, versions, parameters and contracts remain canonical in the owning repository.
- [ ] The page states prerequisites, outcome, verification, likely failures and one next step where applicable.
- [ ] Learning and reference content link back to the owning repository, and repository documentation is updated when required.
- [ ] Planned or scaffold content is clearly labelled and does not imply validation or readiness.
- [ ] I reviewed the [Documentation Information Architecture](../docs/DOCUMENTATION_INFORMATION_ARCHITECTURE.md) and [Engineering Quality Standard](https://github.com/openAMRobot/.github/blob/main/ENGINEERING_QUALITY_STANDARD.md).

## Intellectual property and provenance

- [ ] Every commit is signed off under the OpenAMRobot DCO.
Expand Down
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@

Follow the repository's technical guidance and the organization [Contribution Guide](https://github.com/openAMRobot/.github/blob/main/CONTRIBUTING.md).

## Documentation and quality requirements

Before drafting or reorganizing content, read the [Documentation Information Architecture](docs/DOCUMENTATION_INFORMATION_ARCHITECTURE.md) and the organization [Engineering Quality Standard](https://github.com/openAMRobot/.github/blob/main/ENGINEERING_QUALITY_STANDARD.md).

Every contribution must identify one primary audience, preserve the repository as the canonical source for exact commands, versions, parameters and contracts, include an observable verification outcome, and update bidirectional links between the learning page and owning repository where applicable. Planned content must remain visibly planned and must not imply validated capability.

## Legal requirements

Before acceptance, every commit must satisfy the DCO and the contributor must be covered by an applicable Individual or Corporate Contributor Agreement. Obtain any required employer, university, client, sponsor, co-author, or institutional authorization. Disclose third-party and material AI-assisted content with source, licence, modifications, and notices. Do not submit unauthorized confidential, personal, proprietary, credential, or export-controlled information.
Expand Down
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,12 @@ openamrobot-docs/
└── README.md
```

## Standards

- [Documentation Standard](docs/DOCUMENTATION_STANDARD.md)
- [Documentation Information Architecture](docs/DOCUMENTATION_INFORMATION_ARCHITECTURE.md)
- [Engineering Quality Standard](https://github.com/openAMRobot/.github/blob/main/ENGINEERING_QUALITY_STANDARD.md)

## Documentation Areas

### Core
Expand Down
Loading
Loading