Skip to content

precommit warns on main + instructions for fix #26171

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 27, 2023
Merged

precommit warns on main + instructions for fix #26171

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .github/workflows/clean_pr.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 2 additions & 0 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,10 @@ repos:
- id: mixed-line-ending
- id: name-tests-test
args: ["--pytest-test-first"]
- id: no-commit-to-branch #default is master and main
- id: trailing-whitespace
exclude_types: [svg]

- repo: https://github.com/pycqa/flake8
rev: 6.0.0
hooks:
Expand Down
15 changes: 13 additions & 2 deletions doc/devel/development_workflow.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,10 +63,15 @@ 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
Expand All @@ -79,6 +84,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 from your ``main`` branch and then
converted it to a feature branch, you will need to close the original pull
request and open a new pull request from 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
Expand Down