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 2a21704c27005..a0e9ba53acd00 100644 --- a/doc/source/development/maintaining.rst +++ b/doc/source/development/maintaining.rst @@ -151,6 +151,17 @@ 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`. +Backporting +----------- + +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 ----------------------