31 pre commit docs #36

BryanGK · 2021-12-03T01:15:08Z

PR adds:

Docs relating to using pre-commit locally

BCerki · 2021-12-03T17:32:23Z

docs/pre-commit.md

+### 3 versions of every file that make up our git authoring lifecycle (HEAD, Staged, Unstaged)
+
+### Running the pre-commit hook directly from the .git folder
+- run `bash .git/hooks/pre-commit` to execute pre-commit hook without committing


I think I figured out why this didn't work as expected for me yesterday--I believe this command runs the hook only on the files that are staged, and I didn't have anything staged at the time. If you want to run pre-commit on everything in the repo regardless of staging, it's pre-commit run --all-files

Exactly! Let's get that added to the docs so it's clear when we'd choose to run each command?

BryanGK · 2021-12-03T19:08:01Z

I think this doc is in a good spot right now, but I'm still open to suggestions. Otherwise let's merge it in!

BCerki

You might want to ask someone else to look at this too; I found some parts confusing but that might just be because I'm new to pre-commit

BCerki · 2021-12-03T21:02:44Z

docs/pre-commit.md

+- Install:
+  - Using pip: `pip install pre-commit`
+  - Using Homebrew: `brew install pre-commit`
+
+- Setup
+  - run `pre-commit install` to set up the git hook script


I'd just link to the pre-commit docs, in case they change their instructions later

Fully support both linking to docs and excerpting key text over here (in case the docs are moved or deleted later)

BCerki · 2021-12-03T21:05:22Z

docs/pre-commit.md

+Running hooks on unstaged changes can lead to both false-positives and false-negatives during committing. pre-commit only runs on the staged contents of files by temporarily saving the contents of your files at commit time and stashing the unstaged changes while running hooks.
+


If pre-commit only runs on staged contents (2nd sentence), then how would you be a position to run hooks on unstaged changes (1st sentence)?

That is a direct quote from the docs. https://pre-commit.com/#pre-commit-during-commits I'm not sure how to answer that question

There is no way to run hooks on unstaged changes. This is part of the pre-commit design philosophy and is very important: pre-commit has side effects and by only running on staged changes you can always see the difference between what you wrote and what pre-commit changed.

BCerki · 2021-12-03T21:07:40Z

docs/pre-commit.md

+
+Running hooks on unstaged changes can lead to both false-positives and false-negatives during committing. pre-commit only runs on the staged contents of files by temporarily saving the contents of your files at commit time and stashing the unstaged changes while running hooks.
+
+> pre-commit itself will never touch the staging area. These are good ways to silently break commits. In my mind this is one of the worst things that lint-staged does and suggests -- hooks are very frequently not perfect and magically changing what's being committed should not be taken lightly.


What is this a quote from? I find it a bit confusing, though that could just be shaky understanding of pre-commit

Alec quoted this pre-commit/pre-commit#747 (comment), so I'll add a link to give more context

BCerki · 2021-12-03T21:09:17Z

docs/pre-commit.md

+
+> pre-commit itself will never touch the staging area. These are good ways to silently break commits. In my mind this is one of the worst things that lint-staged does and suggests -- hooks are very frequently not perfect and magically changing what's being committed should not be taken lightly.
+
+Always stage the the changes you intend to commit before running `pre-commit`. If a hook changes our code and fails you will need to manually stage the changes made by `pre-commit`, viewing them one by one with `git add -p` or your preferred git GUI.


What does "before running pre-commit" mean? Running it with the bash script below? (Once I've done pre-commit install, it runs automatically every time I try to commit, so everything is always already staged.)

means anytime pre-commit hooks are run, whether running pre-commit explicitly or by committing. but ill clarify it

BCerki · 2021-12-03T21:12:59Z

docs/pre-commit.md

+
+### Write commit a message so it doesn't get blown away by a failed pre-commit hook
+
+- run `git commit` without a comment when that will then run pre-commit and should it fail you won't lose your commit message. Once it passes it will prompt you to input a commit message.


Suggested change

- run `git commit` without a comment when that will then run pre-commit and should it fail you won't lose your commit message. Once it passes it will prompt you to input a commit message.

- run `git commit` without a comment and that will then run pre-commit and should it fail you won't lose your commit message. Once it passes it will prompt you to input a commit message.

BCerki · 2021-12-03T21:14:48Z

docs/pre-commit.md

+### Write commit a message so it doesn't get blown away by a failed pre-commit hook
+
+- run `git commit` without a comment when that will then run pre-commit and should it fail you won't lose your commit message. Once it passes it will prompt you to input a commit message.
+- **Recomend** on the first commit of a branch to make a commit message body that refs the issue your branch is related. When opening a pull-request this will automatically link your PR to the issue on GitHub. This can be accomplished by creating the commit message in an editor and adding new line at the end of the message and writing `ref #<issue>`


Suggested change

- **Recomend** on the first commit of a branch to make a commit message body that refs the issue your branch is related. When opening a pull-request this will automatically link your PR to the issue on GitHub. This can be accomplished by creating the commit message in an editor and adding new line at the end of the message and writing `ref #<issue>`

- **Recomend** on the first commit of a branch, make a commit message body that refs the issue your branch is related to. When opening a pull-request this will automatically link your PR to the issue on GitHub. This can be accomplished by creating the commit message in an editor and adding new line at the end of the message and writing `ref #<issue>`

I know you can end sentences with prepositions, I just don't like to. I'll make the change :)

Any grammar/spelling suggestions from me will only be for clarity--I have no prescriptive feelings about preposition placement, oxford commas, etc.

docs/pre-commit.md

Co-authored-by: Brianna Cerkiewicz <77306764+BCerki@users.noreply.github.com>

BryanGK added 2 commits December 2, 2021 16:14

feat: adds pre-commit.md file

f9f8893

ref #31

feat: adds to pre-commit.md docs file

dd3f7f3

BryanGK linked an issue Dec 3, 2021 that may be closed by this pull request

Working with pre-commit #31

Closed

BCerki reviewed Dec 3, 2021

View reviewed changes

feat: adds more info to the pre-commit.md

57a80ff

BryanGK marked this pull request as ready for review December 3, 2021 18:39

BryanGK requested a review from BCerki December 3, 2021 19:07

BCerki reviewed Dec 3, 2021

View reviewed changes

docs: changes suggested by reviewer

6d18ef1

BryanGK requested a review from BCerki December 3, 2021 21:54

docs: more reviewer suggestions

a8bf3c0

BCerki previously approved these changes Dec 3, 2021

View reviewed changes

docs/pre-commit.md Outdated Show resolved Hide resolved

docs/pre-commit.md Outdated Show resolved Hide resolved

reviewer suggested updates

ff4277d

Co-authored-by: Brianna Cerkiewicz <77306764+BCerki@users.noreply.github.com>

BryanGK dismissed BCerki’s stale review via ff4277d December 3, 2021 23:06

removes extra 'the'

47b6c1f

Co-authored-by: Brianna Cerkiewicz <77306764+BCerki@users.noreply.github.com>

BryanGK requested a review from BCerki December 3, 2021 23:09

BCerki approved these changes Dec 3, 2021

View reviewed changes

BryanGK merged commit 32edb68 into main Dec 3, 2021

BryanGK deleted the 31-pre-commit-docs branch December 3, 2021 23:11

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

31 pre commit docs #36

31 pre commit docs #36

BryanGK commented Dec 3, 2021

BCerki Dec 3, 2021 •

edited

wenzowski Dec 3, 2021

BryanGK commented Dec 3, 2021

BCerki left a comment

BCerki Dec 3, 2021

wenzowski Dec 3, 2021

BCerki Dec 3, 2021

BryanGK Dec 3, 2021

wenzowski Dec 3, 2021

BCerki Dec 3, 2021

BryanGK Dec 3, 2021

BCerki Dec 3, 2021

BryanGK Dec 3, 2021

BCerki Dec 3, 2021

BCerki Dec 3, 2021

BryanGK Dec 3, 2021

BCerki Dec 3, 2021

		Running hooks on unstaged changes can lead to both false-positives and false-negatives during committing. pre-commit only runs on the staged contents of files by temporarily saving the contents of your files at commit time and stashing the unstaged changes while running hooks.


		Running hooks on unstaged changes can lead to both false-positives and false-negatives during committing. pre-commit only runs on the staged contents of files by temporarily saving the contents of your files at commit time and stashing the unstaged changes while running hooks.

		> pre-commit itself will never touch the staging area. These are good ways to silently break commits. In my mind this is one of the worst things that lint-staged does and suggests -- hooks are very frequently not perfect and magically changing what's being committed should not be taken lightly.


		> pre-commit itself will never touch the staging area. These are good ways to silently break commits. In my mind this is one of the worst things that lint-staged does and suggests -- hooks are very frequently not perfect and magically changing what's being committed should not be taken lightly.

		Always stage the the changes you intend to commit before running `pre-commit`. If a hook changes our code and fails you will need to manually stage the changes made by `pre-commit`, viewing them one by one with `git add -p` or your preferred git GUI.


		### Write commit a message so it doesn't get blown away by a failed pre-commit hook

		- run `git commit` without a comment when that will then run pre-commit and should it fail you won't lose your commit message. Once it passes it will prompt you to input a commit message.

	- run `git commit` without a comment when that will then run pre-commit and should it fail you won't lose your commit message. Once it passes it will prompt you to input a commit message.
	- run `git commit` without a comment and that will then run pre-commit and should it fail you won't lose your commit message. Once it passes it will prompt you to input a commit message.

	- Recomend on the first commit of a branch to make a commit message body that refs the issue your branch is related. When opening a pull-request this will automatically link your PR to the issue on GitHub. This can be accomplished by creating the commit message in an editor and adding new line at the end of the message and writing `ref #<issue>`
	- Recomend on the first commit of a branch, make a commit message body that refs the issue your branch is related to. When opening a pull-request this will automatically link your PR to the issue on GitHub. This can be accomplished by creating the commit message in an editor and adding new line at the end of the message and writing `ref #<issue>`

31 pre commit docs #36

31 pre commit docs #36

Conversation

BryanGK commented Dec 3, 2021

BCerki Dec 3, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BryanGK commented Dec 3, 2021

BCerki left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BCerki Dec 3, 2021 •

edited