Skip to content

Latest commit

 

History

History
45 lines (25 loc) · 1.56 KB

CONTRIBUTING.md

File metadata and controls

45 lines (25 loc) · 1.56 KB
Raw

Contributing to Ably's Common Resources

Development

Protocol

See Ably Realtime Protocol for details on maintaining:

  • Error Codes
  • Error Help (support article links)
  • Agents

Data Files (JSON and YAML)

Our CI check workflow runs Prettier over data files in this repository.

If you want to be sure that changes you make to data files will not fail CI then you can either use Prettier's --check switch as implemented in the aforementioned check workflow:

npm run format:data:check

Or you can simply ask Prettier to rewrite incorrectly formatted data files with this command:

npm run format:data

Note: These invocations naturally include our GitHub workflow source files too. That is intentional.

Markdown Files

Our CI check workflow runs markdownlint-cli2 over all markdown files in this repository.

You can run this tool locally before pushing commits with:

npm run format:documentation:check

Release Process

The outputs from this repository are not yet versioned, though this is planned (#70).

Go Services

The publish workflow must be manually triggered in order to publish to the downstream repository used by some of our internal codebases.

See Ably Realtime Protocol: Publishing Changes for full details.