Skip to content

Commit d78c92a

Browse files
authored
adjust contributing guidelines (#118)
Signed-off-by: Felix Breuer <f.breuer94@gmail.com>
1 parent d88c276 commit d78c92a

File tree

5 files changed

+19
-32
lines changed

5 files changed

+19
-32
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
---
22
name: Bug report
33
about: Report a bug in the machine-controller-manager-provider-stackit
4-
title: ""
5-
labels: bug
6-
assignees: ""
74
---
85

96
## Description
@@ -14,9 +11,6 @@ _Please add a clear and concise description of what the bug is._
1411

1512
_Please provide us with the steps to reproduce the behavior._
1613

17-
1. Run ...
18-
2. ...
19-
2014
## Actual behavior
2115

2216
_Please describe the current behavior of the machine-controller-manager-provider-stackit. Don't forget to add detailed information like error messages._
@@ -30,6 +24,8 @@ _Please describe the behavior which you would expect from the machine-controller
3024
- Kubernetes version:
3125
- Version of the machine-controller-manager-provider-stackit:
3226

33-
**Additional information**
27+
## Additional information
3428

3529
_Feel free to add any additional information here._
30+
31+
/kind bug

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
---
22
name: Feature request
33
about: Suggest an idea for the machine-controller-manager-provider-stackit
4-
title: ""
5-
labels: enhancement
6-
assignees: ""
74
---
85

96
## Problem description
@@ -21,3 +18,5 @@ _A clear and concise description of any alternative solutions or features you've
2118
## Additional information
2219

2320
_Feel free to add any additional information here._
21+
22+
/kind enhancement

CONTRIBUTING.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,7 @@ Before opening a PR, please read through this document.
77

88
## Process of making an addition
99

10-
For major changes, API changes or features please open a [Discussion](https://github.com/stackitcloud/machine-controller-manager-provider-stackit/discussions) or [Issue](https://github.com/stackitcloud/machine-controller-manager-provider-stackit/issues) beforehand to clarify if this is in line with the project and to avoid unnecessary work.
11-
12-
> Use **Discussions** if it needs to be clarified how to implement or to check if this feature is in line with the project. After all clarifications an issue will be created with the details of the implementation.
13-
>
14-
> Use **Issues** if you have a clear plan how to implement to propose how you would do the change.
10+
For major changes, API changes or features please open an [Issue](https://github.com/stackitcloud/machine-controller-manager-provider-stackit/issues) beforehand to clarify if this is in line with the project and to avoid unnecessary work.
1511

1612
To contribute any code to this repository, just do the following:
1713

@@ -20,7 +16,7 @@ To contribute any code to this repository, just do the following:
2016
3. Make your changes
2117
> Please follow the [seven rules of great Git commit messages](https://chris.beams.io/posts/git-commit/#seven-rules)
2218
> and make sure to keep your commits clean and atomic.
23-
> Your PR won't be squashed before merging so the commits should tell a story.
19+
> Your PR will be squashed before merging so the commits can and should tell a story.
2420
>
2521
> Add documentation and tests for your addition if needed.
2622
4. Run `make verify` to ensure your code is ready to be merged
Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@ This document outlines the standard procedure for creating new releases of the S
99
- **Versioning:** Versioning follows official [SemVer 2.0](https://semver.org/)
1010
- **CI/CD System:** All release and image builds are managed by our **Prow CI** infrastructure.
1111

12-
---
13-
1412
## Automated Release Process (Primary Method)
1513

1614
The primary release method is automated using a tool called `release-tool`. This process is designed to be straightforward and require minimal manual intervention.
@@ -20,8 +18,6 @@ The primary release method is automated using a tool called `release-tool`. This
2018

2119
Publishing the release automatically creates the corresponding Git tag (e.g., `v1.3.1`), which triggers a separate Prow job to build the final container images and attach them to the GitHub release.
2220

23-
---
24-
2521
## Manual Release Process (Fallback Method)
2622

2723
If the `release-tool` or its associated Prow job fails, use the GitHub web UI to create and publish a release:

samples/deployment.yaml

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,18 +16,18 @@ spec:
1616
image: europe-docker.pkg.dev/gardener-project/releases/gardener/machine-controller-manager:v0.61.1
1717
imagePullPolicy: Always
1818
command:
19-
- ./machine-controller-manager
20-
- --target-kubeconfig=$(TARGET_KUBECONFIG) # Mandatory Parameter - Filepath to the target cluster's kubeconfig where node objects are expected to join.
21-
- --control-kubeconfig=$(CONTROL_KUBECONFIG) # Optional Parameter - Default value is same as target-kubeconfig - Filepath to the control cluster's kubeconfig where machine objects would be created. Optionally you could also use "inClusterConfig" when pod is running inside control kubeconfig.
22-
- --namespace=$(CONTROL_NAMESPACE) # Optional Parameter - Default value for namespace is 'default' - The control namespace where the controller watches for it's machine objects.
23-
- --safety-up=2 # Optional Parameter - Default value 2 - The number of excess machine objects permitted for any machineSet/machineDeployment beyond its expected number of replicas based on desired and max-surge, we call this the upper-limit. When this upper-limit is reached, the objects are frozen until the number of objects reduce. upper-limit = desired + maxSurge (if applicable) + safetyUp.
24-
- --safety-down=1 # Optional Parameter - Default value 1 - Upper-limit minus safety-down value gives the lower-limit. This is the limits below which any temporarily frozen machineSet/machineDeployment object is unfrozen. lower-limit = desired + maxSurge (if applicable) + safetyUp - safetyDown.
25-
- --machine-drain-timeout=5m # Optional Parameter - Timeout (in time) used while draining of machine before deletion, beyond which MCM forcefully deletes machine.
26-
- --machine-health-timeout=10m # Optional Parameter - Default value 10mins - Timeout (in time) used while joining (during creation) or re-joining (in case of temporary health issues) of machine before it is declared as failed.
27-
- --machine-safety-orphan-vms-period=30 # Optional Parameter - Default value 30mins - Time period (in time) used to poll for orphan VMs by safety controller.
28-
- --machine-safety-overshooting-period=1 # Optional Parameter - Default value 1min - Time period (in time) used to poll for overshooting of machine objects backing a machineSet by safety controller.
29-
- --node-conditions=ReadonlyFilesystem,KernelDeadlock,DiskPressure # List of comma-separated/case-sensitive node-conditions which when set to True will change machine to a failed state after MachineHealthTimeout duration. It may further be replaced with a new machine if the machine is backed by a machine-set object.
30-
- --v=3
19+
- ./machine-controller-manager
20+
- --target-kubeconfig=$(TARGET_KUBECONFIG) # Mandatory Parameter - Filepath to the target cluster's kubeconfig where node objects are expected to join.
21+
- --control-kubeconfig=$(CONTROL_KUBECONFIG) # Optional Parameter - Default value is same as target-kubeconfig - Filepath to the control cluster's kubeconfig where machine objects would be created. Optionally you could also use "inClusterConfig" when pod is running inside control kubeconfig.
22+
- --namespace=$(CONTROL_NAMESPACE) # Optional Parameter - Default value for namespace is 'default' - The control namespace where the controller watches for it's machine objects.
23+
- --safety-up=2 # Optional Parameter - Default value 2 - The number of excess machine objects permitted for any machineSet/machineDeployment beyond its expected number of replicas based on desired and max-surge, we call this the upper-limit. When this upper-limit is reached, the objects are frozen until the number of objects reduce. upper-limit = desired + maxSurge (if applicable) + safetyUp.
24+
- --safety-down=1 # Optional Parameter - Default value 1 - Upper-limit minus safety-down value gives the lower-limit. This is the limits below which any temporarily frozen machineSet/machineDeployment object is unfrozen. lower-limit = desired + maxSurge (if applicable) + safetyUp - safetyDown.
25+
- --machine-drain-timeout=5m # Optional Parameter - Timeout (in time) used while draining of machine before deletion, beyond which MCM forcefully deletes machine.
26+
- --machine-health-timeout=10m # Optional Parameter - Default value 10mins - Timeout (in time) used while joining (during creation) or re-joining (in case of temporary health issues) of machine before it is declared as failed.
27+
- --machine-safety-orphan-vms-period=30 # Optional Parameter - Default value 30mins - Time period (in time) used to poll for orphan VMs by safety controller.
28+
- --machine-safety-overshooting-period=1 # Optional Parameter - Default value 1min - Time period (in time) used to poll for overshooting of machine objects backing a machineSet by safety controller.
29+
- --node-conditions=ReadonlyFilesystem,KernelDeadlock,DiskPressure # List of comma-separated/case-sensitive node-conditions which when set to True will change machine to a failed state after MachineHealthTimeout duration. It may further be replaced with a new machine if the machine is backed by a machine-set object.
30+
- --v=3
3131
livenessProbe:
3232
failureThreshold: 3
3333
httpGet:

0 commit comments

Comments
 (0)