Skip to content

Commit 5c245b9

Browse files
hitman99Tomas Adomavicius
and
Tomas Adomavicius
authored
update readme with contribution notes (#64)
Co-authored-by: Tomas Adomavicius <tomas.adomavicius@devbridge.com>
1 parent 7815496 commit 5c245b9

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,3 +95,26 @@ This creates a user role `username-<hash>` and grants role `test-db-group`, `tes
9595
`PostgresUser` needs to reference a `Postgres` in the same namespace.
9696

9797
Two `Postgres` referencing the same database can exist in more than one namespace. The last CR referencing a database will drop the group role and transfer database ownership to the role used by the operator.
98+
99+
100+
### Contribution
101+
You can contribute to this project by opening a PR to merge to `master`, or one of the `vX.X.X` branches.
102+
#### Branching
103+
`master` branch contains the latest source code with all the features. `vX.X.X` contains code for the specific major versions.
104+
i.e. `v0.4.x` contains the latest code for 0.4 version of the operator. See compatibility matrix below.
105+
106+
#### Tests
107+
Please write tests and fix any broken tests before you open a PR. Tests should cover at least 80% of your code.
108+
109+
### Compatibility
110+
Postgres operator uses Operator SDK, which uses kubernetes client. Kubernetes client compatibility with Kubernetes cluster
111+
can be found [here](https://github.com/kubernetes/client-go/blob/master/README.md#compatibility-matrix)
112+
113+
Postgres operator compatibility with Operator SDK version is in the table below
114+
115+
| | Operator SDK 0.17.x | Operator SDK 1.9.0 |
116+
|-------------------------------|---------------------|--------------------|
117+
| `postgres-operator 0.4.x` | ✓ | - |
118+
| `postgres-operator 1.0.x` | - | ✓ |
119+
| `HEAD` | ✓ | - |
120+

0 commit comments

Comments
 (0)