]> git.madduck.net Git - etc/vim.git/blobdiff - CONTRIBUTING.md

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:

projects / etc / vim.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
skip tests touching aiohttp when known exception occurs
[etc/vim.git] / CONTRIBUTING.md
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 4c94ea726fae207aeac948a73b478292fbcb5a93..be7c50528ab07d7dc080393a6ddb1c469fd27626 100644 (file)
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,16 +1,18 @@
-# Contributing to Black
+# Contributing to *Black*
 
 Welcome! Happy to see you willing to make the project better. Have you
-read the entire [README](README.md) yet?
+read the entire [user documentation](https://black.readthedocs.io/en/latest/)
+yet?
 
 
 ## Bird's eye view
 
-In terms of inspiration, *Black* is about as configurable as *gofmt* and
-*rustfmt* are.  This is deliberate.
+In terms of inspiration, *Black* is about as configurable as *gofmt*.
+This is deliberate.
 
-Bug reports and fixes are always welcome!  Please follow the issue
-template on GitHub for best results.
+Bug reports and fixes are always welcome!  Please follow the [issue
+template on GitHub](https://github.com/psf/black/issues/new) for best 
+results.
 
 Before you suggest a new feature or configuration knob, ask yourself why
 you want it.  If it enables better integration with some workflow, fixes
@@ -23,16 +25,18 @@ to get accepted. You can still try but prepare to be disappointed.
 ## Technicalities
 
 Development on the latest version of Python is preferred.  As of this
-writing it's 3.6.4.  You can use any operating system.  I am using macOS
+writing it's 3.7  You can use any operating system.  I am using macOS
 myself and CentOS at work.
 
 Install all development dependencies using:
 ```
 $ pipenv install --dev
+$ pipenv shell
+$ pre-commit install
 ```
 If you haven't used `pipenv` before but are comfortable with virtualenvs,
 just run `pip install pipenv` in the virtualenv you're already using and
-invoke the command above from the cloned Black repo. It will do the
+invoke the command above from the cloned *Black* repo. It will do the
 correct thing.
 
 Before submitting pull requests, run tests with:
@@ -40,10 +44,6 @@ Before submitting pull requests, run tests with:
 $ python setup.py test
 ```
 
-Also run mypy and flake8 on `black.py` and `test_black.py`.  Travis will
-run all that for you but if you left any errors here, it will be quicker
-and less embarrassing to fix them locally ;-)
-
 
 ## Hygiene
 
vim configuration

Legalese

All content available in this repository is copyright © martin f. krafft, unless otherwise noted.

All files and their content are released under the terms of the Artistic Licence 2.0, unless otherwise noted.

The operator of this repository shall not be held liable for offending content in pages linking to or linked from these page, nor does he endorse their content unless stated otherwise.