From 08b2bff55afbb22d46e41dd547bf153b1a65f5c6 Mon Sep 17 00:00:00 2001 From: Yun Dai Date: Thu, 29 Aug 2024 13:30:54 -0700 Subject: [PATCH 1/3] Update CONTRIBUTING.md --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8466ebc30..63dd9558c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -52,7 +52,7 @@ Fork the repo, copy and paste the successful test logs in the PR and submit the ## Release (maintainer only) -1. Bump the version in setup.py +1. Bump the version in setup.py to the desired version (for example, `0.2.0` 2. Submit a PR and merge -3. Create a new release based on the current HEAD -4. New pip uploading will be triggered upon a new release +3. Create a new release based on the current HEAD, tag name using `v` for example `v0.2.0`. Alternatively, If you want to create release based on a different commit hash, `git tag v0.2.0 && git push origin v0.2.0`, and create release based on this tag +4. New pip uploading will be triggered upon a new release. NOTE: Both pre-release and official release will trigger the workflow to build wheel and publish to pypi, so please be sure that step 1-3 are followed correctly! From 7220211a0c264b6aef40e4e6fd6200a6f3e00bdf Mon Sep 17 00:00:00 2001 From: Yun Dai Date: Thu, 29 Aug 2024 13:34:40 -0700 Subject: [PATCH 2/3] Update CONTRIBUTING.md --- CONTRIBUTING.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 63dd9558c..2ba0cf228 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -52,7 +52,13 @@ Fork the repo, copy and paste the successful test logs in the PR and submit the ## Release (maintainer only) -1. Bump the version in setup.py to the desired version (for example, `0.2.0` +1. Bump the version in setup.py to the desired version (for example, `0.2.0`) 2. Submit a PR and merge 3. Create a new release based on the current HEAD, tag name using `v` for example `v0.2.0`. Alternatively, If you want to create release based on a different commit hash, `git tag v0.2.0 && git push origin v0.2.0`, and create release based on this tag 4. New pip uploading will be triggered upon a new release. NOTE: Both pre-release and official release will trigger the workflow to build wheel and publish to pypi, so please be sure that step 1-3 are followed correctly! + +### Notes on version: +Here we follow the [sematic versioning](https://semver.org/). Denote the version as `major.minor.patch`, we increment: +- Major version when there is backward incompatible change +- Minor version when there is new backward-compatible functionaility +- Patch version for bug fixes From 7a2ab0531b4be470afd482f53777f099cf3b3ab0 Mon Sep 17 00:00:00 2001 From: Yun Dai Date: Thu, 29 Aug 2024 16:16:45 -0700 Subject: [PATCH 3/3] Update CONTRIBUTING.md --- CONTRIBUTING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2ba0cf228..54b780c71 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -55,7 +55,8 @@ Fork the repo, copy and paste the successful test logs in the PR and submit the 1. Bump the version in setup.py to the desired version (for example, `0.2.0`) 2. Submit a PR and merge 3. Create a new release based on the current HEAD, tag name using `v` for example `v0.2.0`. Alternatively, If you want to create release based on a different commit hash, `git tag v0.2.0 && git push origin v0.2.0`, and create release based on this tag -4. New pip uploading will be triggered upon a new release. NOTE: Both pre-release and official release will trigger the workflow to build wheel and publish to pypi, so please be sure that step 1-3 are followed correctly! +4. Adding release note: Minimum requirement is to click the `Generate Release Notes` button that will automatically generates 1) changes included, 2) new contributors. It's good to add sections on top to highlight the important changes. +5. New pip uploading will be triggered upon a new release. NOTE: Both pre-release and official release will trigger the workflow to build wheel and publish to pypi, so please be sure that step 1-3 are followed correctly! ### Notes on version: Here we follow the [sematic versioning](https://semver.org/). Denote the version as `major.minor.patch`, we increment: