Skip to content

Commit 397c9d3

Browse files
committed
docs: Update readme
1 parent 8d188ea commit 397c9d3

File tree

1 file changed

+28
-18
lines changed

1 file changed

+28
-18
lines changed

README.md

Lines changed: 28 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,6 @@ A CRD-less, annotation-based controller which mutates StatefulSets and
33
ServiceAccounts so Google Cloud Storage buckets are mounted in the app using
44
gcsfuse.
55

6-
## Description
7-
// TODO(user): An in-depth paragraph about your project and overview of use
8-
96
## Getting Started
107

118
### Prerequisites
@@ -79,25 +76,38 @@ Users can just run kubectl apply -f <URL for YAML BUNDLE> to install the project
7976
kubectl apply -f https://raw.githubusercontent.com/<org>/ssbucketeer/<tag or branch>/dist/install.yaml
8077
```
8178

82-
## Contributing
83-
// TODO(user): Add detailed information on how you would like others to contribute to this project
79+
# Contributing
80+
81+
Please follow these guidelines when contributing.
82+
83+
## Commit messages and merging PRs
84+
85+
Use squash merges, not merge commits.
86+
This allows the release-please workflow to parse them and create a changelog.
8487

85-
**NOTE:** Run `make help` for more information on all potential `make` targets
88+
This project follows [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for its commit messages - **this also applies to squash merge messages**.
89+
You can check out the following resources for more explanation/motivation:
90+
[The power of conventional commits](https://julien.ponge.org/blog/the-power-of-conventional-commits/)
91+
and
92+
[Conventional Commit Messages](https://gist.github.com/qoomon/5dfcdf8eec66a051ecd85625518cfd13).
8693

87-
More information can be found via the [Kubebuilder Documentation](https://book.kubebuilder.io/introduction.html)
94+
When working on experimental branches you can use whatever commit messages you want, but you should either squash/amend your messages before merging your PR.
95+
Using [Scratchpad branches](https://julien.ponge.org/blog/a-workflow-for-experiments-in-git-scratchpad-branches/) is probably the easiest approach.
8896

89-
## License
97+
Use the provided pre-commit hook to verify your commit messages:
98+
```sh
99+
pre-commit install --install-hooks
100+
pre-commit install -t commit-msg
101+
```
90102

91-
Copyright 2024.
103+
## Creating a release
92104

93-
Licensed under the Apache License, Version 2.0 (the "License");
94-
you may not use this file except in compliance with the License.
95-
You may obtain a copy of the License at
105+
Google's [release-please](https://github.com/googleapis/release-please) is used to create releases.
106+
release-please maintains a release PR, which determines the next semver version based on whether there have been feature additions, breaking changes, etc.
107+
To create a release, simply merge that PR, and it will create a GitHub release, tag and a Docker image will be built.
96108

97-
http://www.apache.org/licenses/LICENSE-2.0
109+
The suggested next version can be overriden by including `Release-As: x.x.x` in a commit message. For example:
98110

99-
Unless required by applicable law or agreed to in writing, software
100-
distributed under the License is distributed on an "AS IS" BASIS,
101-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
102-
See the License for the specific language governing permissions and
103-
limitations under the License.
111+
```sh
112+
git commit --allow-empty -m "chore: release 2.0.0" -m "Release-As: 2.0.0"
113+
```

0 commit comments

Comments
 (0)