Merge pull request #111 from cybertec-postgresql/Issue_template

update templates & developer doc

Author: Schmaetz

.github/ISSUE_TEMPLATE/postgres-operator-issue-template.md

@@ -1,19 +1,70 @@
 ---
-name: Postgres Operator issue template
+name: CYBERTEC-PG-Operator issue template
 about: How are you using the operator?
-title: ''
+title: '[BUG] Brief description of the problem'
 labels: ''
 assignees: ''
 
 ---
 
-Please, answer some short questions which should help us to understand your problem / question better?
+To quickly narrow down the problem, we need details about your infrastructure.
 
-- **Which image of the operator are you using?** e.g. registry.opensource.zalan.do/acid/postgres-operator:v1.10.1
-- **Where do you run it - cloud or metal? Kubernetes or OpenShift?** [AWS K8s | GCP ... | Bare Metal K8s]
-- **Are you running Postgres Operator in production?** [yes | no]
-- **Type of issue?** [Bug report, question, feature request, etc.]
+- **Operator version / image:** [e.g. docker.io/cybertecpostgresql/cybertec-pg-operator:v0.9.0-1]
+- **Postgres Docker Image:** [e.g., containers.cybertec.at/cybertec-pg-container/postgres:rocky9-18.1-1]
+- **Kubernetes Platform:** [Please check or add]
+    - [ ] Vanilla Kubernetes (Bare Metal / VM)
+    - [ ] OpenShift
+    - [ ] Rancher / RKE / RKE2
+    - [ ] AWS EKS
+    - [ ] Google GKE
+    - [ ] Azure AKS
+    - [ ] Minikube / Kind / K3s
+    - [ ] Other: ________
+- **Kubernetes version:** [Output of `kubectl version`, e.g. v1.28.3]
+- **Storage Class:** [e.g., standard, gp2, longhorn, ceph-rbd]
+- **Is the operator running in production?** [Yes / No]
 
-Some general remarks when posting a bug report:
-- Please, check the operator, pod (Patroni) and postgresql logs first. When copy-pasting many log lines please do it in a separate GitHub gist together with your Postgres CRD and configuration manifest.
-- If you feel this issue might be more related to the [Spilo](https://github.com/zalando/spilo/issues) docker image or [Patroni](https://github.com/zalando/patroni/issues), consider opening issues in the respective repos.
+---
+
+### Problem Description
+
+**What happened?**
+Describe the unexpected behavior.
+
+**What did you expect?**
+Describe what should have happened.
+
+---
+
+### Steps to reproduce
+
+How can we reproduce the problem?
+1. Applied Postgres cluster manifest (see below)
+2. Executed command: `...`
+3. Error occurs when ...
+
+---
+
+### Relevant logs and manifests
+
+**IMPORTANT:** Please use code blocks (```) to format logs and YAML files in a readable way.
+
+**1. Operator logs:**
+(Please check the logs of the operator pod for errors)
+```text
+Insert logs here...
+```
+
+**2. Postgres / Patroni /pgBackRest logs: (If the pod starts but the DB is not running):**
+(Please check the logs of the postgres or pgbackrest pod for errors)
+```text
+Insert logs here...
+```
+
+**3. Postgres Cluster Manifest (YAML): (Please remove passwords or sensitive data!)**
+```yaml
+Insert Manifest here...
+```
+
+**Additional information**
+Are there any special circumstances in your setup? (e.g., service mesh such as Istio/Linkerd, special network policies, air-gapped environment?)

.github/PULL_REQUEST_TEMPLATE/postgres-operator-pull-request-template.md

@@ -1,18 +1,27 @@
-## Problem description
-
-
-
-## Linked issues
+## Description
+## Type of Change
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Documentation update
 
 
+## Linked Issues
+---
 
 ## Checklist
 
-Thanks for submitting a pull request to the Postgres Operator project.
-Please, ensure your contribution matches the following items:
+Thanks for submitting a pull request to the CYBERTEC-pg-operator project!
+Please ensure your contribution matches the following items:
+
+- [ ] **Code Formatting:** My code follows the Go formatting standards. (Your IDE should do this automatically, or run `go fmt`).
+- [ ] **Generated Code:** I have updated [generated code](https://cybertec-postgresql.github.io/CYBERTEC-pg-operator/contribution#code-generation) (clientset, deepcopy) when introducing new fields to the `cpo.opensource.cybertec.at` API package.
+- [ ] **Configuration & CRDs:** New [configuration options](https://cybertec-postgresql.github.io/CYBERTEC-pg-operator/contribution#introduce-additional-configuration-parameters) are reflected in:
+    - [ ] The Go struct definitions
+    - [ ] The CRD validation manifests (YAML)
+    - [ ] The Helm Charts
+    - [ ] The sample manifests
+- [ ] **Tests:** New functionality is covered by [unit tests](https://cybertec-postgresql.github.io/CYBERTEC-pg-operator/contribution#unit-tests) and/or [e2e tests](https://cybertec-postgresql.github.io/CYBERTEC-pg-operator/contribution#end-to-end-tests).
+- [ ] **Existing PRs:** I have checked existing open PRs to ensure there are no duplicates or conflicts.
 
-- [ ] Your go code is [formatted](https://blog.golang.org/gofmt). Your IDE should do it automatically for you.
-- [ ] You have updated [generated code](https://github.com/zalando/postgres-operator/blob/master/docs/developer.md#code-generation) when introducing new fields to the `acid.zalan.do` api package.
-- [ ] New [configuration options](https://github.com/zalando/postgres-operator/blob/master/docs/developer.md#introduce-additional-configuration-parameters) are reflected in CRD validation, helm charts and sample manifests.
-- [ ] New functionality is covered by [unit](https://github.com/zalando/postgres-operator/blob/master/docs/developer.md#unit-tests) and/or [e2e](https://github.com/zalando/postgres-operator/blob/master/docs/developer.md#end-to-end-tests) tests.
-- [ ] You have checked existing open PRs for possible overlay and referenced them.
+## How has this been tested?