Skip to content

Contributing

Before you change code

Read the relevant requirement and contract. Check the current mode and provider boundary. Do not replace a live error with replay or local fixture data.

Before you change docs

Use the same terms as Key terms. Use one idea per sentence. Use active voice. State the actor and the action. Write the limit when a claim has a limit.

Prefer:

Select View quest details to read the quest. This action does not start an attempt.

Avoid:

The quest experience can be initiated from the constellation surface in order to facilitate a more contextualized learning journey.

Validation

Run:

npm run typecheck
npm test
npm run lint
npm run build
npm run docs:build
git diff --check

Run the backend checks when backend files change.

Pull request notes

Describe:

  • the user problem;
  • the changed contract;
  • the tests;
  • the runtime mode used for browser proof;
  • any external blocker.

Do not claim a production integration from a replay or local fixture result.

Licensing

Orion is distributed under the repository LICENSE. Keep third-party notices and source attribution with the files that use them.