From 9f1b72b8bb8dc8035ccd7ad9db8237e941bfadaf Mon Sep 17 00:00:00 2001 From: 1nF0rmed Date: Tue, 29 Dec 2020 00:35:47 +0530 Subject: [PATCH 1/4] Fixes #38726 --- doc/source/development/contributing.rst | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/doc/source/development/contributing.rst b/doc/source/development/contributing.rst index 86d495ef2b097..69cff96a6c45f 100644 --- a/doc/source/development/contributing.rst +++ b/doc/source/development/contributing.rst @@ -1610,6 +1610,28 @@ request by pushing to the branch on GitHub:: git push origin shiny-new-feature +Autofixing formatting errors +---------------------------- + +We use several styling checks(e.g. ``black``, ``flake8``, ``isort``) which are run after +you make a pull request. If there is a scenario where any of these checks fail then you +can comment:: + + @githubactions pre-commit + +on that pull request. This will trigger a workflow which will autofix formatting errors. + +Backporting (optional) +---------------------- + +In the case you want to apply changes to a stable branch from a newer branch then you +can comment:: + + @meeseeksdev backport + +This will trigger a workflow which will backport a given change to a branch +(e.g. @meeseeksdev backport 1.2.x) + Delete your merged branch (optional) ------------------------------------ From 3bfe3f4eed77b0983e8cdd777f07c1aca9d1a6bb Mon Sep 17 00:00:00 2001 From: Pradyumna Rahul Date: Tue, 29 Dec 2020 02:04:07 +0530 Subject: [PATCH 2/4] DOC: chat-ops (#38726) --- doc/source/development/contributing.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/source/development/contributing.rst b/doc/source/development/contributing.rst index 69cff96a6c45f..0fa99d17f5862 100644 --- a/doc/source/development/contributing.rst +++ b/doc/source/development/contributing.rst @@ -1613,7 +1613,7 @@ request by pushing to the branch on GitHub:: Autofixing formatting errors ---------------------------- -We use several styling checks(e.g. ``black``, ``flake8``, ``isort``) which are run after +We use several styling checks(e.g. ``black``, ``flake8``, ``isort``) which are run after you make a pull request. If there is a scenario where any of these checks fail then you can comment:: @@ -1624,13 +1624,13 @@ on that pull request. This will trigger a workflow which will autofix formatting Backporting (optional) ---------------------- -In the case you want to apply changes to a stable branch from a newer branch then you +In the case you want to apply changes to a stable branch from a newer branch then you can comment:: @meeseeksdev backport This will trigger a workflow which will backport a given change to a branch -(e.g. @meeseeksdev backport 1.2.x) +(e.g. ``@meeseeksdev backport 1.2.x``) Delete your merged branch (optional) ------------------------------------ From 5ae8045a3afefe9ae38a568e8c88f6eb479122f7 Mon Sep 17 00:00:00 2001 From: 1nF0rmed Date: Tue, 29 Dec 2020 17:00:43 +0530 Subject: [PATCH 3/4] Minor changes --- doc/source/development/contributing.rst | 22 ---------------------- doc/source/development/maintaining.rst | 22 ++++++++++++++++++++++ 2 files changed, 22 insertions(+), 22 deletions(-) diff --git a/doc/source/development/contributing.rst b/doc/source/development/contributing.rst index 69cff96a6c45f..86d495ef2b097 100644 --- a/doc/source/development/contributing.rst +++ b/doc/source/development/contributing.rst @@ -1610,28 +1610,6 @@ request by pushing to the branch on GitHub:: git push origin shiny-new-feature -Autofixing formatting errors ----------------------------- - -We use several styling checks(e.g. ``black``, ``flake8``, ``isort``) which are run after -you make a pull request. If there is a scenario where any of these checks fail then you -can comment:: - - @githubactions pre-commit - -on that pull request. This will trigger a workflow which will autofix formatting errors. - -Backporting (optional) ----------------------- - -In the case you want to apply changes to a stable branch from a newer branch then you -can comment:: - - @meeseeksdev backport - -This will trigger a workflow which will backport a given change to a branch -(e.g. @meeseeksdev backport 1.2.x) - Delete your merged branch (optional) ------------------------------------ diff --git a/doc/source/development/maintaining.rst b/doc/source/development/maintaining.rst index 2a21704c27005..629fe6d487b1b 100644 --- a/doc/source/development/maintaining.rst +++ b/doc/source/development/maintaining.rst @@ -151,6 +151,28 @@ Here are some things to check when reviewing a pull request. for regression fixes and small bug fixes, the next minor milestone otherwise) * Changes should comply with our :ref:`policies.version`. +Autofixing formatting errors +---------------------------- + +We use several styling checks (e.g. ``black``, ``flake8``, ``isort``) which are run after +you make a pull request. If there is a scenario where any of these checks fail then you +can comment:: + + @github-actions pre-commit + +on that pull request. This will trigger a workflow which will autofix formatting errors. + +Backporting (optional) +---------------------- + +In the case you want to apply changes to a stable branch from a newer branch then you +can comment:: + + @meeseeksdev backport version-branch + +This will trigger a workflow which will backport a given change to a branch +(e.g. @meeseeksdev backport 1.2.x) + Cleaning up old issues ---------------------- From ab7ff99e4a50fc081b773fddd8242b58a6b6b914 Mon Sep 17 00:00:00 2001 From: 1nF0rmed Date: Tue, 29 Dec 2020 20:45:52 +0530 Subject: [PATCH 4/4] Moving autofixing section to contributing.rst --- doc/source/development/contributing.rst | 11 +++++++++++ doc/source/development/maintaining.rst | 11 ----------- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/doc/source/development/contributing.rst b/doc/source/development/contributing.rst index 86d495ef2b097..b810c71e3daa6 100644 --- a/doc/source/development/contributing.rst +++ b/doc/source/development/contributing.rst @@ -1610,6 +1610,17 @@ request by pushing to the branch on GitHub:: git push origin shiny-new-feature +Autofixing formatting errors +---------------------------- + +We use several styling checks (e.g. ``black``, ``flake8``, ``isort``) which are run after +you make a pull request. If there is a scenario where any of these checks fail then you +can comment:: + + @github-actions pre-commit + +on that pull request. This will trigger a workflow which will autofix formatting errors. + Delete your merged branch (optional) ------------------------------------ diff --git a/doc/source/development/maintaining.rst b/doc/source/development/maintaining.rst index 7e0c83ab06c68..a0e9ba53acd00 100644 --- a/doc/source/development/maintaining.rst +++ b/doc/source/development/maintaining.rst @@ -151,17 +151,6 @@ Here are some things to check when reviewing a pull request. for regression fixes and small bug fixes, the next minor milestone otherwise) * Changes should comply with our :ref:`policies.version`. -Autofixing formatting errors ----------------------------- - -We use several styling checks (e.g. ``black``, ``flake8``, ``isort``) which are run after -you make a pull request. If there is a scenario where any of these checks fail then you -can comment:: - - @github-actions pre-commit - -on that pull request. This will trigger a workflow which will autofix formatting errors. - Backporting -----------