From 2a6c5235af14bb5a350df968f9101ef4b8b28fc0 Mon Sep 17 00:00:00 2001 From: Gregor Sturm Date: Tue, 10 Dec 2024 15:18:36 +0100 Subject: [PATCH 1/6] Hotfix policy --- developer/hotfix-policy.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 developer/hotfix-policy.md diff --git a/developer/hotfix-policy.md b/developer/hotfix-policy.md new file mode 100644 index 0000000..047b305 --- /dev/null +++ b/developer/hotfix-policy.md @@ -0,0 +1,20 @@ +# Hotfix policy + +Each scverse core package is maintained by one or multiple core developers who merge pull requests and make releases. +While all core team members are welcome to contribute to all repos, it is typically the realm of the maintaiers +to review and merge pull requests. The purpose of this document is to document under which circumstances we +deviate from this rule and to the process we adhere to. + +**If a critical fix is required for any core package (security issue, package not installable, CI breaks, ...) +other core team members are allows to make required fixes and make a patch release.** Please adhere to the following rules: + * Reach out to the maintainer(s) first. Depending on the severity of the issue give them one business day to react. + * Four-eye principle: find another developer to review your pull request with the fixes. + * Only fix what is absolutely necessary. Do not add new features or refactor the codebase. + +## Documenting release process + +A prerequisite for others to make a release of the package is that the release process is properly documented +and permissions are properly set. Releases to PyPI are to be automated via GitHub actions using +a [trusted publishing](https://docs.pypi.org/trusted-publishers/) workflow. + + From a2485860418f402694a36b0fe4a02d189d02b419 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Tue, 10 Dec 2024 14:40:37 +0000 Subject: [PATCH 2/6] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- developer/hotfix-policy.md | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/developer/hotfix-policy.md b/developer/hotfix-policy.md index 047b305..60d8668 100644 --- a/developer/hotfix-policy.md +++ b/developer/hotfix-policy.md @@ -1,20 +1,19 @@ # Hotfix policy -Each scverse core package is maintained by one or multiple core developers who merge pull requests and make releases. +Each scverse core package is maintained by one or multiple core developers who merge pull requests and make releases. While all core team members are welcome to contribute to all repos, it is typically the realm of the maintaiers -to review and merge pull requests. The purpose of this document is to document under which circumstances we -deviate from this rule and to the process we adhere to. +to review and merge pull requests. The purpose of this document is to document under which circumstances we +deviate from this rule and to the process we adhere to. **If a critical fix is required for any core package (security issue, package not installable, CI breaks, ...) -other core team members are allows to make required fixes and make a patch release.** Please adhere to the following rules: - * Reach out to the maintainer(s) first. Depending on the severity of the issue give them one business day to react. - * Four-eye principle: find another developer to review your pull request with the fixes. - * Only fix what is absolutely necessary. Do not add new features or refactor the codebase. +other core team members are allows to make required fixes and make a patch release.** Please adhere to the following rules: + +- Reach out to the maintainer(s) first. Depending on the severity of the issue give them one business day to react. +- Four-eye principle: find another developer to review your pull request with the fixes. +- Only fix what is absolutely necessary. Do not add new features or refactor the codebase. ## Documenting release process A prerequisite for others to make a release of the package is that the release process is properly documented -and permissions are properly set. Releases to PyPI are to be automated via GitHub actions using -a [trusted publishing](https://docs.pypi.org/trusted-publishers/) workflow. - - +and permissions are properly set. Releases to PyPI are to be automated via GitHub actions using +a [trusted publishing](https://docs.pypi.org/trusted-publishers/) workflow. From f23a58437b3e85056194aecf7212f15bf136b549 Mon Sep 17 00:00:00 2001 From: Gregor Sturm Date: Tue, 10 Dec 2024 15:53:50 +0100 Subject: [PATCH 3/6] Update developer/hotfix-policy.md Co-authored-by: Ilan Gold --- developer/hotfix-policy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/developer/hotfix-policy.md b/developer/hotfix-policy.md index 60d8668..ae4fe8b 100644 --- a/developer/hotfix-policy.md +++ b/developer/hotfix-policy.md @@ -2,7 +2,7 @@ Each scverse core package is maintained by one or multiple core developers who merge pull requests and make releases. While all core team members are welcome to contribute to all repos, it is typically the realm of the maintaiers -to review and merge pull requests. The purpose of this document is to document under which circumstances we +to review and merge pull requests, as well as to make releases. The purpose of this document is to document under which circumstances we deviate from this rule and to the process we adhere to. **If a critical fix is required for any core package (security issue, package not installable, CI breaks, ...) From 72a49ad1e42ba929233d73cbced5a2fbc11cae7c Mon Sep 17 00:00:00 2001 From: Gregor Sturm Date: Tue, 10 Dec 2024 15:54:00 +0100 Subject: [PATCH 4/6] Update developer/hotfix-policy.md Co-authored-by: Philipp A. --- developer/hotfix-policy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/developer/hotfix-policy.md b/developer/hotfix-policy.md index ae4fe8b..5d8c8cc 100644 --- a/developer/hotfix-policy.md +++ b/developer/hotfix-policy.md @@ -1,7 +1,7 @@ # Hotfix policy Each scverse core package is maintained by one or multiple core developers who merge pull requests and make releases. -While all core team members are welcome to contribute to all repos, it is typically the realm of the maintaiers +While all core team members are welcome to contribute to all repos, it is typically the realm of the maintainers to review and merge pull requests, as well as to make releases. The purpose of this document is to document under which circumstances we deviate from this rule and to the process we adhere to. From 4e8a7f73a5b023d6fbb67c586b8ef0b016d7c792 Mon Sep 17 00:00:00 2001 From: Gregor Sturm Date: Tue, 10 Dec 2024 15:54:06 +0100 Subject: [PATCH 5/6] Update developer/hotfix-policy.md Co-authored-by: Philipp A. --- developer/hotfix-policy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/developer/hotfix-policy.md b/developer/hotfix-policy.md index 5d8c8cc..61050d5 100644 --- a/developer/hotfix-policy.md +++ b/developer/hotfix-policy.md @@ -3,7 +3,7 @@ Each scverse core package is maintained by one or multiple core developers who merge pull requests and make releases. While all core team members are welcome to contribute to all repos, it is typically the realm of the maintainers to review and merge pull requests, as well as to make releases. The purpose of this document is to document under which circumstances we -deviate from this rule and to the process we adhere to. +deviate from this rule and the process we adhere to. **If a critical fix is required for any core package (security issue, package not installable, CI breaks, ...) other core team members are allows to make required fixes and make a patch release.** Please adhere to the following rules: From fdb925c0745e3a3bb1d623ce446db05d429c302e Mon Sep 17 00:00:00 2001 From: Gregor Sturm Date: Tue, 10 Dec 2024 16:03:28 +0100 Subject: [PATCH 6/6] Update developer/hotfix-policy.md Co-authored-by: Severin Dicks <37635888+Intron7@users.noreply.github.com> --- developer/hotfix-policy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/developer/hotfix-policy.md b/developer/hotfix-policy.md index 61050d5..042404e 100644 --- a/developer/hotfix-policy.md +++ b/developer/hotfix-policy.md @@ -9,7 +9,7 @@ deviate from this rule and the process we adhere to. other core team members are allows to make required fixes and make a patch release.** Please adhere to the following rules: - Reach out to the maintainer(s) first. Depending on the severity of the issue give them one business day to react. -- Four-eye principle: find another developer to review your pull request with the fixes. +- Four-eye principle: find another (core) developer to review your pull request with the fixes. - Only fix what is absolutely necessary. Do not add new features or refactor the codebase. ## Documenting release process