Skip to content

Commit 889de14

Browse files
streamline contributing guidelines (#753)
Signed-off-by: Felix Breuer <f.breuer94@gmail.com> Co-authored-by: Felix Breuer <f.breuer94@gmail.com>
1 parent 772dcf6 commit 889de14

File tree

4 files changed

+13
-31
lines changed

4 files changed

+13
-31
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 3 additions & 4 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 cloud-provider-stackit
4-
title: ""
5-
labels: bug
6-
assignees: ""
74
---
85

96
## Description
@@ -30,6 +27,8 @@ _Please describe the behavior which you would expect from the cloud-provider-sta
3027
- Kubernetes version:
3128
- Version of the cloud-provider-stackit:
3229

33-
**Additional information**
30+
## Additional information
3431

3532
_Feel free to add any additional information here._
33+
34+
/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 cloud-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: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,14 @@ For major changes, API changes or features please open a [Discussion](https://gi
1313
>
1414
> Use **Issues** if you have a clear plan how to implement to propose how you would do the change.
1515
16-
1716
To contribute any code to this repository, just do the following:
1817

1918
1. Make sure you have Go's latest version installed
2019
2. Fork this repository
2120
3. Make your changes
2221
> Please follow the [seven rules of great Git commit messages](https://chris.beams.io/posts/git-commit/#seven-rules)
2322
> and make sure to keep your commits clean and atomic.
24-
> Your PR won't be squashed before merging so the commits should tell a story.
23+
> Your PR will be squashed before merging so the commits can and should tell a story.
2524
>
2625
> Add documentation and tests for your addition if needed.
2726
4. Run `make verify` to ensure your code is ready to be merged

docs/release-procedure.md

Lines changed: 7 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,6 @@ This document outlines the standard procedure for creating new releases of the C
1919
- `PATCH` is incremented for each subsequent release within the same Kubernetes version
2020
- **CI/CD System:** All release and image builds are managed by our **Prow CI** infrastructure.
2121

22-
---
23-
2422
## Automated Release Process (Primary Method)
2523

2624
The primary release method is automated using a tool called `release-tool`. This process is designed to be straightforward and require minimal manual intervention.
@@ -30,31 +28,18 @@ The primary release method is automated using a tool called `release-tool`. This
3028

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

33-
---
34-
3531
## Manual Release Process (Fallback Method)
3632

37-
If the `release-tool` or its associated Prow job fails, you can manually trigger a release by creating and pushing a Git tag from the appropriate release branch.
38-
39-
1. **Check out the release branch:** Ensure you have the latest changes from the correct release branch.
33+
If the `release-tool` or its associated Prow job fails, use the GitHub web UI to create and publish a release:
4034

41-
```bash
42-
git checkout release-v1.33.x
43-
git pull origin release-v1.33.x
44-
```
35+
1. Go to the repository on GitHub and click **Releases** on the right side, then click **Draft new release**.
4536

46-
2. **Create the Git tag:** Create a new, annotated tag for the release, following semantic versioning.
37+
2. Open the **Select tag** dropdown and choose **Create new tag** at the bottom. Enter the new tag name (for example `v2.1.0`) and pick the correct `release-` as target branch, then confirm.
4738

48-
```bash
49-
# Example for creating version v1.33.1
50-
git tag v1.33.1
51-
```
39+
3. Click **Generate release notes** to let GitHub populate the changelog.
5240

53-
3. **Push the tag to the remote repository:**
41+
4. In the release description, add a line `Released by @<your github handle>` to indicate the publisher.
5442

55-
```bash
56-
# Example for pushing tag v1.33.1
57-
git push origin v1.33.1
58-
```
43+
5. Click **Publish release** to create the release.
5944

60-
Pushing a tag that starts with `v` (e.g., `v1.33.1`) automatically triggers the same Prow release job that builds and publishes the final container images. You may need to manually update the release notes on GitHub afterward.
45+
Publishing a new release triggers the same Prow release job that builds and publishes the final container images.

0 commit comments

Comments
 (0)