Contribute

The codebases for the Charmed PostgreSQL operators are undergoing some structural changes in an effort to simplify development of both code and documentation.

The general guidance during this time for contributors is to get in touch with us first so we can help you navigate your contribution.

Development

At this time, if you’d like to contribute to the code, see the contributing guides in

• postgresql-operator (machine charm) on the 16/edge branch: 16/edge/CONTRIBUTING.md

• postgresql-k8s-operator (K8s charm) on the 16/edge branch: 16/edge/CONTRIBUTING.md

We recommend you get in touch with us if you’d like to contribute - either via issues on GitHub or chatting with us directly on Matrix .

See also: Contact

Documentation

Contributions to Charmed PostgreSQL documentation are welcomed and encouraged.

All documentation is in the postgresql-single-kernel-library repository

While the code is still in a period of transition between GitHub repositories, the documentation for all Charmed PostgreSQL operators and versions has transferred to the postgresql-single-kernel-library repository :

• postgresql-single-kernel-library branch 16/docs contains the docs for both VM and K8s charms for PostgreSQL 16 (newest)

• postgresql-single-kernel-library branch 14/docs contains the docs for both VM and K8s charms for PostgreSQL 14

Prerequisites

• A GitHub account: See Creating an account on GitHub

• Code of Conduct compliance: You must read and follow the Ubuntu Code of Conduct . Maintainers reserve the right to delete or remove any contributions that do not respect the Code of Conduct.

Report an issue

To report an issue in spelling, grammar, or technical content, file an issue on GitHub with the documentation label. A maintainer will update it as soon as possible.

Make a contribution

To make a quick update yourself, the easiest way is to click the pencil icon in the top-right corner of the documentation page (next to the “Give feedback” button). It will take you to the GitHub web editor for that page, and you can submit the PR directly through the web interface.

Merge against 16/docs

All documentation pull requests should be made against the 16/docs branch – not 16/edge.

For larger, more involved contributions, please create an issue on GitHub with the documentation tag, and assign it to yourself. A maintainer will get in touch with you. Alternatively, you are welcome to contact us directly via Matrix .

See also: Contact