# Contributing to Ably's Common Resources

## Development

### Protocol

See [Ably Realtime Protocol](protocol) for details on maintaining:

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

### Data Files (JSON and YAML)

Our [CI check workflow](.github/workflows/check.yml) runs [Prettier](https://prettier.io/) 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](.github/workflows) too.
That is intentional.

### Markdown Files

Our [CI check workflow](.github/workflows/check.yml) runs [markdownlint-cli2](https://www.npmjs.com/package/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](https://github.com/ably/ably-common/issues/70)).

### Go Services

The [publish workflow](.github/workflows/publish.yml) must be manually triggered in order to publish to the [downstream repository](https://github.com/ably/ably-common-go) used by some of our internal codebases.

See [Ably Realtime Protocol: Publishing Changes](protocol#publishing-changes) for full details.