Commit e81fe86
check for pr from main: precommit check + action in pr_clean
+ instructions for fix in docs
Co-authored-by: Greg Lucas <greg.m.lucas@gmail.com>
Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com>1 parent 0b8bd96 commit e81fe86
3 files changed
Lines changed: 20 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -45,3 +45,8 @@ jobs: | |||
| 45 | 45 | printf 'Changes to the following files have no effect and should not be backported:\n%s\n' "$lib" | |
| 46 | 46 | exit 1 | |
| 47 | 47 | fi | |
| 48 | + - name: Check for branches opened against main | ||
| 49 | + if: github.ref_name == 'main' | ||
| 50 | + run: | | ||
| 51 | + printf 'PR branch should not be main. See https://matplotlib.org/devdocs/devel/development_workflow.html#make-a-new-feature-branch' | ||
| 52 | + exit 1 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -23,8 +23,10 @@ repos: | |||
| 23 | 23 | - id: mixed-line-ending | |
| 24 | 24 | - id: name-tests-test | |
| 25 | 25 | args: ["--pytest-test-first"] | |
| 26 | + - id: no-commit-to-branch #default is master and main | ||
| 26 | 27 | - id: trailing-whitespace | |
| 27 | 28 | exclude_types: [svg] | |
| 29 | + | ||
| 28 | 30 | - repo: https://github.com/pycqa/flake8 | |
| 29 | 31 | rev: 6.0.0 | |
| 30 | 32 | hooks: | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -63,10 +63,15 @@ what the changes in the branch are for. For example ``add-ability-to-fly``, or | |||
| 63 | 63 | git branch my-new-feature upstream/main | |
| 64 | 64 | git checkout my-new-feature | |
| 65 | 65 | ||
| 66 | + If you started making changes on your local ``main`` branch, you can convert the | ||
| 67 | + branch to a feature branch by renaming it:: | ||
| 68 | + | ||
| 69 | + git branch -m <newname> | ||
| 70 | + | ||
| 66 | 71 | Generally, you will want to keep your feature branches on your public GitHub | |
| 67 | 72 | fork of Matplotlib. To do this, you ``git push`` this new branch up to your | |
| 68 | - GitHub repo. Generally (if you followed the instructions in these pages, and by | ||
| 69 | - default), git will have a link to your fork of the GitHub repo, called | ||
| 73 | + GitHub repo. Generally, if you followed the instructions in these pages, and by | ||
| 74 | + default, git will have a link to your fork of the GitHub repo, called | ||
| 70 | 75 | ``origin``. You push up to your own fork with:: | |
| 71 | 76 | ||
| 72 | 77 | git push origin my-new-feature | |
@@ -79,6 +84,12 @@ In git >= 1.7 you can ensure that the link is correctly set by using the | |||
| 79 | 84 | From now on git will know that ``my-new-feature`` is related to the | |
| 80 | 85 | ``my-new-feature`` branch in the GitHub repo. | |
| 81 | 86 | ||
| 87 | + If you first opened the pull request from your ``main`` branch and then | ||
| 88 | + converted it to a feature branch, you will need to close the original pull | ||
| 89 | + request and open a new pull request from the renamed branch. See | ||
| 90 | + `GitHub: working with branches | ||
| 91 | + <https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches#working-with-branches>`_. | ||
| 92 | + | ||
| 82 | 93 | .. _edit-flow: | |
| 83 | 94 | ||
| 84 | 95 | The editing workflow | |
0 commit comments