Skip to content

DOC - Update documentation regarding formatting files #2057

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 2 commits into from
Dec 2, 2024
Merged

DOC - Update documentation regarding formatting files #2057

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2e2a957
:memo: Update documentation regarding formatting files
trallard Nov 28, 2024
3f30357
Apply suggestions from code review
trallard Nov 28, 2024
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
3 changes: 1 addition & 2 deletions .git-blame-ignore-revs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@
# commit hash here, so git blame can ignore the change.
#
# For more details, see:
# https://git-scm.com/docs/git-config#Documentation/git-config.txt-blameignoreRevsFile
# https://github.com/pydata/pydata-sphinx-theme/pull/713
# https://pydata-sphinx-theme.readthedocs.io/en/stable/community/topics/attribution.html
#
90550b66ace16a370caa446e54698b126fda740b # initial black-format
236d4c6d1f10f5da064d929e9eb594daecf23551 # apply black 20.8b1 format
Expand Down
25 changes: 22 additions & 3 deletions docs/community/topics/attribution.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,27 @@
# Ignore formatting commits with `git blame`

When making commits that are strictly formatting/style changes (e.g., after running a new version of black or running pyupgrade after dropping an old Python version), add the commit hash to `.git-blame-ignore-revs`, so `git blame` can ignore the change.
Please follow these steps to avoid obscuring file history when making commits that are
strictly formatting/style changes (e.g., after running a new version of black or running
pyupgrade after dropping an old Python version).

1. Create a new branch.
2. Make any linting and formatting rules needed; either in the `pre-commit.config.yaml`
or in the `pyproject.toml` file.
3. Commit your changes with the `--no-verify` flag to skip the pre-commit hooks.
4. Run the pre-commit hooks manually with `tox run -e lint` or `pre-commit run --all-files`.
5. Commit the linting and formatting changes.
6. Open a PR with these changes.

```{important}
This PR **must** be rebase-merged -- instead of the default squash-merge we
currently follow -- so a repository admin needs to enable this setting in the
repository temporarily.

```

7. Open a new PR adding the commit hashes of the formatting commits to the `.git-blame-ignore-revs` file.

For more details, see:

- https://git-scm.com/docs/git-config#Documentation/git-config.txt-blameignoreRevsFile
- https://github.com/pydata/pydata-sphinx-theme/pull/713
- <https://git-scm.com/docs/git-config#Documentation/git-config.txt-blameignoreRevsFile>
- <https://github.com/pydata/pydata-sphinx-theme/pull/713>
Loading