You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+5-6Lines changed: 5 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -250,9 +250,9 @@ mise x -- telepresence connect
250
250
# Receive traffic to a pod by replacing it in the cluster
251
251
mise x -- telepresence replace <pod-name>
252
252
253
-
# More information about how replace/intercept/ingress works can be found in the [Telepresence documentation](https://telepresence.io/docs/howtos/engage).
253
+
# More information about how replace/intercept/ingress works: https://telepresence.io/docs/howtos/engage
254
+
254
255
# Once done, quit Telepresence using:
255
-
```sh
256
256
mise x -- telepresence quit
257
257
```
258
258
@@ -328,7 +328,7 @@ This would
328
328
329
329
### Step 2: QA & Polish the release on release branch
330
330
331
-
You can then iteratively polish the release in `main` branch and cherry-pick the commits to `release`. When you are ready to create a new release candidate, run `mise run release:bump` to bump up the release candidate version.
331
+
You can then iteratively polish the release in `main` branch and cherry-pick the commits to `release`. When you are ready to create a new release candidate, run `mise run release:publish-rc` to bump up the release candidate version.
332
332
333
333
Creating new RC would trigger GH action to deploy pre-release version of the package for testing.
334
334
@@ -337,14 +337,13 @@ Creating new RC would trigger GH action to deploy pre-release version of the pac
337
337
Once you've verified the RC version works, publish the final release from the `release` branch:
338
338
339
339
```shell
340
-
git checkout release
341
-
mise run release:publish
340
+
mise run release:publish-rc
342
341
```
343
342
344
343
This task will simply create a final tag for `release` version and push, which triggers GH action to deploy to pypi and npm.
345
344
346
345
## Documentation
347
346
348
-
All changes that modify existing features or introduce new functionality must include documentation updates as part of the pull request. Documentation files should be added or updated in the `docs` folder.
347
+
All changes that modify existing features or introduce new functionality must include documentation updates as part of the pull request. Documentation files should be added or updated in the `docs/development` folder.
349
348
350
349
A GitHub workflow automatically checks that documentation requirements are met. If your change does not require documentation updates (e.g., bug fixes that don't change behavior, internal refactoring, or test-only changes), you must explicitly note this in your PR description.
0 commit comments