]>
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:
+# Contributing to *Black*
Welcome! Happy to see you willing to make the project better. Have you
Welcome! Happy to see you willing to make the project better. Have you
-read the entire [user documentation](http://black.readthedocs.io/en/latest/)
+read the entire [user documentation](https ://black.readthedocs.io/en/latest/)
-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
Before you suggest a new feature or configuration knob, ask yourself why
you want it. If it enables better integration with some workflow, fixes
## Technicalities
Development on the latest version of Python is preferred. As of this
## 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
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
```
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:
correct thing.
Before submitting pull requests, run tests with:
$ python setup.py test
```
$ 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 ;-)
-
projects / etc / vim.git / blobdiff