Skip to content

Latest commit

 

History

History
63 lines (45 loc) · 2.13 KB

CONTRIBUTING.md

File metadata and controls

63 lines (45 loc) · 2.13 KB

Contributing to CloudNativePG

Welcome! We are glad that you want to contribute to our CloudNativePG project! 💖

As you get started, you are in the best position to give us feedbacks on areas of our project that we need help with, including:

  • Problems found while setting up the development environment
  • Gaps in our documentation
  • Bugs in our Github actions
  • Promotion of PostgreSQL on Kubernetes with our operator

First, though, it is important that you read the code of conduct.

The guidelines below are a starting point. We don't want to limit your creativity, passion, and initiative. If you think there's a better way, please feel free to bring it up in a Github discussion, or open a pull request. We're certain there are always better ways to do things, we just need to start some constructive dialogue!

Ways to contribute

We welcome many types of contributions including:

  • New features
  • Builds, CI/CD
  • Bug fixes
  • Documentation
  • Issue Triage
  • Answering questions on Slack or Github Discussions
  • Web design
  • Communications / Social Media / Blog Posts
  • Events participation
  • Release management

For development contributions, please refer to the separate section called "Contributing to the source code".

Ask for Help

The best way to reach us with a question when contributing is to drop a line in our Slack channel, or start a new Github discussion.

Raising Issues

When raising issues, please specify the following:

  • Setup details as specified in the issue template
  • A scenario where the issue occurred (with details on how to reproduce it)
  • Errors and log messages that are displayed by the involved software
  • Any other detail that might be useful

If you are trying to report a vulnerability, please refer to the security policy.

Meetings

We extend a warm welcome to everyone to join any of our meetings. For further details, please visit the CloudNativePG Community Meetings page.