Upgrading, contributing, licence

This page covers the project around the code. It says which version these docs describe and where to find docs for an older one, then how to upgrade, how to contribute, and the licence.

Which version these docs describe

This site documents the latest published version of liaise, the one shown in the header. It has no pages for older versions. For those, read the README at that version’s tag on GitHub:

5.1.x: the README at 5.1.1.
5.0.x: the README at 5.0.3.
4.x, published as @iremlopsum/apify: the README at 4.4.3.

Up to 5.1.1 the README was the full documentation, and every release in the changelog has a tag, so the README for any of those versions is at https://github.com/iremlopsum/liaise/blob/v<version>/README.md.

Upgrading

liaise follows Semantic Versioning, so a change that can break your code comes in a new major version.

MIGRATION.md says what to change when an upgrade needs it. Only releases that need action appear there. If a version isn’t listed, upgrading to it needs no changes.
CHANGELOG.md lists what changed in every release. The same notes are on GitHub Releases.

Coming from @iremlopsum/apify? That is liaise’s old name. Switching takes two steps, listed in Upgrading to 5.0.0.

Contributing

Bug reports, fixes and ideas are welcome. CONTRIBUTING.md explains how to report a bug, run the tests, and the few rules a pull request is checked against.

To report a bug, open a bug report. A small piece of code that shows the problem helps most: the endpoint, the call, what you expected and what you got. If it happens on one runtime only, say which one and which version.
To suggest a feature, open a feature request and start with the problem you’re trying to solve. liaise stays small on purpose, so a problem that middleware or a few lines of your own code can’t solve has the best chance.
A pull request is checked against a few rules. It adds no runtime dependencies, every public call still returns a Result instead of throwing, every fix comes with a test that fails without the fix, and the docs change with the code. CONTRIBUTING.md lists them all, with the commands CI runs.

Licence

liaise is released under the MIT licence. The full text is in LICENSE.

That’s the end of the docs. To start building, go to Quick start. Issues, releases and the code are on GitHub.