Skip to content

Commit 3717afc

Browse files
authored
docs: conventional commit in dev guide, README fix (#109)
1 parent 7d5bb86 commit 3717afc

File tree

2 files changed

+17
-10
lines changed

2 files changed

+17
-10
lines changed

DEVELOPMENT.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
1-
# kube-startup-cpu-boost development guide
1+
# Development guide
2+
3+
## Commit messages
4+
5+
We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) specification
6+
for commit messages to automate the release process. The spec is enforced by github action based validation.
27

38
## Running development cluster
49

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -162,10 +162,11 @@ container(s) will be increase by the given percentage value.
162162

163163
```yaml
164164
spec:
165-
containerPolicies:
166-
- containerName: spring-rest-jpa
167-
percentageIncrease:
168-
value: 50
165+
resourcePolicy:
166+
containerPolicies:
167+
- containerName: spring-rest-jpa
168+
percentageIncrease:
169+
value: 50
169170
```
170171

171172
### [Boost resources] fixed target
@@ -176,11 +177,12 @@ higher than the ones in the container.
176177

177178
```yaml
178179
spec:
179-
containerPolicies:
180-
- containerName: spring-rest-jpa
181-
fixedResources:
182-
requests: "1"
183-
limits: "2"
180+
resourcePolicy:
181+
containerPolicies:
182+
- containerName: spring-rest-jpa
183+
fixedResources:
184+
requests: "1"
185+
limits: "2"
184186
```
185187

186188
### [Boost duration] fixed time

0 commit comments

Comments
 (0)