docs: Add notes about development tools #161
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adds notes about how to run the linter, renderer and mock server, as well as a suggestion they be run before opening a PR.
johnbilt
reviewed
Jan 6, 2026
| ### 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). |
Contributor
There was a problem hiding this comment.
Docker image requires an x86 based processor (as I found out when trying to run on an arm based instance)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Details
Adds notes about how to run the linter, renderer and mock server, as well as a suggestion they be run before opening a PR.
Jira Issue (if relevant)
Jira URL: N/A - a good suggestion from @johnbilt
Related PRs
N/A
Submitter PR Checks
(tick as appropriate)
Reviewer PR Checks
(tick as appropriate)
Info on PRs
The checks above are guidelines. They don't all have to be ticked, but they should all have been considered.