|
1 | 1 | # Contributing to CloudNativePG |
2 | 2 |
|
3 | | -Welcome! We are glad that you want to contribute to the CloudNativePG project! 💖 |
| 3 | +Thank you for your interest in contributing! 💖 |
4 | 4 |
|
5 | | -To get started, here's some areas the project could really use some help with: |
| 5 | +To ensure consistency across the project, all CloudNativePG repositories follow |
| 6 | +a common set of guidelines regarding code of conduct, AI usage, and |
| 7 | +contribution workflows. |
6 | 8 |
|
7 | | -* Problems found while setting up the development environment |
8 | | -* Gaps in our documentation |
9 | | -* Bugs in our GitHub actions |
10 | | -* Promotion of PostgreSQL on Kubernetes with our operator |
| 9 | +Please review the [CloudNativePG Project contributing guidelines](https://github.com/cloudnative-pg/governance/blob/main/CONTRIBUTING.md) |
| 10 | +before searching for issues, reporting bugs, or submitting a pull request. |
11 | 11 |
|
12 | | -First, though, it is important that you read the |
13 | | -[code of conduct](CODE_OF_CONDUCT.md). |
14 | | - |
15 | | -The guidelines below are a starting point. We don't want to limit your |
16 | | -creativity, passion, and initiative. If you think there are other things |
17 | | -you can contribute, please feel free to bring it up in a GitHub Issue, |
18 | | -or open a Pull Request! |
19 | | - |
20 | | -## Ways to contribute |
21 | | - |
22 | | -We welcome many types of contributions including: |
23 | | - |
24 | | -* New features |
25 | | -* Builds, CI/CD |
26 | | -* Bug fixes |
27 | | -* [Documentation](docs/README.md) |
28 | | -* Issue Triage |
29 | | -* Answering questions on [Slack](README.md#communications) or GitHub Discussions |
30 | | -* The [website](https://github.com/cloudnative-pg/cloudnative-pg.github.io) |
31 | | -* Communications / Social Media / Blog Posts |
32 | | -* Advocacy at Events (let us know when your talk about CloudNativePG is accepted!) |
33 | | -* Release management |
| 12 | +--- |
34 | 13 |
|
35 | 14 | For development contributions, please refer to the separate section called |
36 | 15 | ["Contributing to the source code"](contribute/README.md). |
37 | | - |
38 | | -## External Contributors vs Maintainers |
39 | | - |
40 | | -**External Contributors:** If you're contributing from outside the core team, please note that some instructions in our detailed development docs apply only to maintainers. See the [development contribution guide](contribute/README.md) for complete details, but note: |
41 | | - |
42 | | -- **Issue Assignment**: Comment "I'd like to work on this" instead of self-assigning |
43 | | -- **Testing**: Run local unit tests and basic e2e tests (see [testing guide](contribute/e2e_testing_environment/README.md)); maintainers will handle comprehensive cloud-based E2E testing |
44 | | -- **Project Boards**: Maintainers will move tickets through project phases |
45 | | - |
46 | | -## Ask for Help |
47 | | - |
48 | | -The best way to reach us with a question when contributing is to drop a line in |
49 | | -our [Slack channel](README.md#communications), or start a new GitHub discussion. |
50 | | - |
51 | | -## Raising Issues |
52 | | - |
53 | | -When raising [Issues](https://github.com/cloudnative-pg/cloudnative-pg/issues), please specify the following: |
54 | | - |
55 | | -* Setup details as specified in the Issue template |
56 | | -* A scenario where the issue occurred (with details on how to reproduce it) |
57 | | -* Errors and log messages that are displayed by the involved software |
58 | | -* Any other detail that might be useful |
59 | | - |
60 | | -If you are trying to report a vulnerability, please refer to the |
61 | | -[security policy](SECURITY.md). |
62 | | - |
63 | | -## Meetings |
64 | | - |
65 | | -We extend a warm welcome to everyone to join any of our meetings. |
66 | | -For further details, please visit the |
67 | | -[CloudNativePG Community Meetings](https://github.com/cloudnative-pg#cloudnativepg-community-meetings) page. |
68 | | - |
0 commit comments