precommit warns on main + instructions for fix in docs

story645 · greglucas · story645 · commit 28d6a2623cd3 · 2023-06-22T22:50:09.000-04:00
Co-authored-by: Greg Lucas &lt;greg.m.lucas@gmail.com&gt;
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -23,8 +23,11 @@ repos:
       - id: mixed-line-ending
       - id: name-tests-test
         args: ["--pytest-test-first"]
+      - id: no-commit-to-branch #default is master and main
+        name: no commit to main branch. See "https://matplotlib.org/devdocs/devel/development_workflow.html#make-a-new-feature-branch"
       - id: trailing-whitespace
         exclude_types: [svg]
+
   - repo: https://github.com/pycqa/flake8
     rev: 6.0.0
     hooks:
diff --git a/doc/devel/development_workflow.rst b/doc/devel/development_workflow.rst
@@ -63,6 +63,11 @@ what the changes in the branch are for.  For example ``add-ability-to-fly``, or
     git branch my-new-feature upstream/main
     git checkout my-new-feature
 
+If you started making changes on your local ``main`` branch, you can rename the
+branch to a feature branch::
+
+   git branch -m <newname>
+
 Generally, you will want to keep your feature branches on your public GitHub
 fork of Matplotlib.  To do this, you ``git push`` this new branch up to your
 GitHub repo.  Generally (if you followed the instructions in these pages, and by
@@ -79,6 +84,7 @@ In git >= 1.7 you can ensure that the link is correctly set by using the
 From now on git will know that ``my-new-feature`` is related to the
 ``my-new-feature`` branch in the GitHub repo.
 
+
 .. _edit-flow:
 
 The editing workflow
