Welcome! We are glad that you want to contribute to the CloudNativePG project! 💖
The guidelines below are a starting point for all repositories under the CloudNativePG organization.
CloudNativePG is a community-driven project. While many maintainers are sponsored by their respective employers, they operate here on a voluntary basis. Before contributing, please review our core policies:
- Code of Conduct: Our standards for a welcoming community.
- AI Policy: Guidelines regarding the use of Generative AI in contributions.
Important
We are all human beings with finite time and a limited amount of cognitive load we can sustain at any given moment. Given the rapid growth and technical complexity of the project, maintainers must carefully balance planned roadmap items and critical maintenance (such as the current transition of Barman Cloud to plugins and moving from base-image extensions to self-contained ones).
We extend a warm welcome to everyone to join our meetings. For details, please visit the CloudNativePG Community page.
We welcome many types of contributions including:
- Issue Triage
- Answering questions on Slack or GitHub Discussions
- Advocacy at Events (let us know when your talk about CloudNativePG is accepted!)
- The CloudNativePG website
- Documentation:
- New features and Bug fixes
- Builds, CI/CD, and Release management
- Communications / Social Media / Blog Posts
To respect everyone's time, please follow these steps before submitting a Pull Request:
- Search First: Before reporting a new issue, please check the documentation and ensure a similar issue has not been opened in the past.
- Open an Issue: Always start by opening a GitHub Issue to discuss your idea. Ensure maintainers have agreed on the approach and priority before you spend time writing code.
- Fork and Branch: Fork the relevant project. We recommend developing
your feature in a branch named with the issue ID (e.g.,
dev/43). - Test: Ensure you have tested your code locally according to the specific repository's instructions.
- Experimental Path: If your patch cannot wait or is highly experimental, remember that the CNPG-I interface provides the freedom to build and test features as plugins. Once a feature is proven and well-received by the community, we can discuss moving it into the core.
If you are reporting a vulnerability, please refer to the Security Policy.
Important
External Contributors: If you're contributing to the CloudNativePG operator from outside the core team, please note that some repository-specific instructions (such as those in the operator's detailed development docs) apply only to maintainers. See the development contribution guide for complete details.