Skip to content

docs: Add notes about development tools #161

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
samdbmg wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Add notes about development tools #161

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,10 @@ The process is:
- `sem-ver: feature` - where a new feature has been added
- `sem-ver: deprecation` - where an existing feature has been marked as deprecated, but not yet removed
4. If you haven't already done so, sign the CLA (see below)
5. Open a Pull Request with your changes.
Don't worry about leaving empty spaces on the PR template (it's aimed at internal contributions), just fill in the description
5. Prior to opening a Pull Request you may wish to run the linter with `make lint`: see [Development](./README.md#development) for more on the targets available
6. Open a Pull Request with your changes.
Don't worry about leaving empty spaces on the PR template (it's aimed at internal contributions), just fill in the description.
A maintainer will review your changes, and trigger the CI process.

## Contributor Licence Agreement (CLA)

Expand Down
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,20 @@ It is assumed that implementations will apply other IT and cloud infrastructure
This repository uses [(M)ADR documents](https://adr.github.io/madr/) to propose significant changes, facilitate discussions and decision making, and to store a record of options that were considered.
These documents may be found in the [docs/adr](./docs/adr/) directory, and are managed as described by the [ADR Readme](./docs/adr/README.md).

### Development

This repository contains a [Makefile](./Makefile) with various targets to aid specification development.
These rely on having Docker available on the system, and are primarily tested on Linux (but may work on other platforms).
Copy link
Contributor

@johnbilt johnbilt Jan 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docker image requires an x86 based processor (as I found out when trying to run on an arm based instance)

Linting and documentation rendering are also handled by GitHub Actions when Pull Requests are submitted and merged.

The following targets are available:

- `make lint` - Lint Markdown documents, validate API specifications, examples and schemas
- `make render` - Generate HTML rendered version of OpenAPI spec (at `api/docs/index.html`)
- `make mock-server-up` - Start a mock TAMS API on <http://localhost:4010/?access_token=fake>

Note that for the mock server, some credentials must be supplied to meet the spec; either an `Authorization` header for HTTP Basic/Bearer token, or an `access_token` query string.

## Making a release

Run the `release` workflow under the `Actions` tab on this repository on GitHub against the `main` branch.
Expand Down
Loading