]> git.madduck.net Git - etc/vim.git/commitdiff

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Update CONTRIBUTION.md with pre-commit + black-primer instructions (#1459)
authorCooper Lees <me@cooperlees.com>
Sun, 24 May 2020 19:02:52 +0000 (12:02 -0700)
committerGitHub <noreply@github.com>
Sun, 24 May 2020 19:02:52 +0000 (12:02 -0700)
* Update CONTRIBUTION with pre-commit + black-primer instructions
- Inform people how to run primer and alter it's config
- Link to main documentation

* Apply suggestions from code review

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
CONTRIBUTING.md

index 91e5320e2830321f347c6f56200336a1b3a9ce6a..525cb9c183d3979447a09145ff24736212d0e93e 100644 (file)
@@ -24,7 +24,7 @@ You can use any operating system. I am using macOS myself and CentOS at work.
 
 Install all development dependencies using:
 
 
 Install all development dependencies using:
 
-```
+```console
 $ pipenv install --dev
 $ pipenv shell
 $ pre-commit install
 $ pipenv install --dev
 $ pipenv shell
 $ pre-commit install
@@ -34,12 +34,26 @@ If you haven't used `pipenv` before but are comfortable with virtualenvs, just r
 `pip install pipenv` in the virtualenv you're already using and invoke the command above
 from the cloned _Black_ repo. It will do the correct thing.
 
 `pip install pipenv` in the virtualenv you're already using and invoke the command above
 from the cloned _Black_ repo. It will do the correct thing.
 
-Before submitting pull requests, run tests with:
+Before submitting pull requests, run lints and tests with:
 
 
-```
+```console
+$ pre-commit run -a
 $ python -m unittest
 $ python -m unittest
+$ black-primer [-k -w /tmp/black_test_repos]
 ```
 
 ```
 
+## black-primer
+
+`black-primer` is used by CI to pull down well-known _Black_ formatted projects and see
+if we get soure code changes. It will error on formatting changes or errors. Please run
+before pushing your PR to see if you get the actions you would expect from _Black_ with
+your PR. You may need to change
+[primer.json](https://github.com/psf/black/blob/master/src/black_primer/primer.json)
+configuration for it to pass.
+
+For more `black-primer` information visit the
+[documentation](https://github.com/psf/black/blob/master/docs/black_primer.md).
+
 ## Hygiene
 
 If you're fixing a bug, add a test. Run it first to confirm it fails, then fix the bug,
 ## Hygiene
 
 If you're fixing a bug, add a test. Run it first to confirm it fails, then fix the bug,