precommit warns on main + failing action + instructions for fix in docs

story645 · greglucas · story645 · commit 34d8fc38474f · 2023-06-23T15:23:50.000-04:00
Co-authored-by: Greg Lucas &lt;greg.m.lucas@gmail.com&gt;
diff --git a/.github/workflows/clean_pr.yml b/.github/workflows/clean_pr.yml
@@ -45,3 +45,8 @@ jobs:
             printf 'Changes to the following files have no effect and should not be backported:\n%s\n' "$lib"
             exit 1
           fi
+      - name: Check for branches opened against main
+        if: github.ref_name == 'main'
+        run: |
+        printf 'PR branch should not be main. See https://matplotlib.org/devdocs/devel/development_workflow.html#make-a-new-feature-branch'
+        exit 1
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: branch is not named `main`. Fix is `git branch -m <newname>`
       - 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,10 +63,16 @@ 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 convert the
+branch to a feature branch by renaming it::
+
+   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
-default), git will have a link to your fork of the GitHub repo, called
+GitHub repo.  Generally, if you followed the instructions in these pages, and by
+default, git will have a link to your fork of the GitHub repo, called
 ``origin``.  You push up to your own fork with::
 
    git push origin my-new-feature
@@ -79,6 +85,12 @@ 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.
 
+If you first opened the pull request on ``main`` and then converted it to a
+feature branch, you will need to close the original pull request and open a new
+one for the renamed branch. See
+`Github: working with branches <https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches#working-with-branches>`_.
+
+
 .. _edit-flow:
 
 The editing workflow
