git.madduck.net Git - etc/vim.git/blob

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.

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

1 # Contributing to Black

3 Welcome! Happy to see you willing to make the project better. Have you

4 read the entire [user documentation](http://black.readthedocs.io/en/latest/)

5 yet?

8 ## Bird's eye view

10 In terms of inspiration, *Black* is about as configurable as *gofmt* and

11 *rustfmt* are. This is deliberate.

13 Bug reports and fixes are always welcome! Please follow the issue

14 template on GitHub for best results.

16 Before you suggest a new feature or configuration knob, ask yourself why

17 you want it. If it enables better integration with some workflow, fixes

18 an inconsistency, speeds things up, and so on - go for it! On the other

19 hand, if your answer is "because I don't like a particular formatting"

20 then you're not ready to embrace *Black* yet. Such changes are unlikely

21 to get accepted. You can still try but prepare to be disappointed.

24 ## Technicalities

26 Development on the latest version of Python is preferred. As of this

27 writing it's 3.6.4. You can use any operating system. I am using macOS

28 myself and CentOS at work.

30 Install all development dependencies using:

31 ```

32 $ pipenv install --dev

33 ```

34 If you haven't used `pipenv` before but are comfortable with virtualenvs,

35 just run `pip install pipenv` in the virtualenv you're already using and

36 invoke the command above from the cloned Black repo. It will do the

37 correct thing.

39 Before submitting pull requests, run tests with:

40 ```

41 $ python setup.py test

42 ```

44 Also run mypy and flake8 on `black.py` and `test_black.py`. Travis will

45 run all that for you but if you left any errors here, it will be quicker

46 and less embarrassing to fix them locally ;-)

49 ## Hygiene

51 If you're fixing a bug, add a test. Run it first to confirm it fails,

52 then fix the bug, run it again to confirm it's really fixed.

54 If adding a new feature, add a test. In fact, always add a test. But

55 wait, before adding any large feature, first open an issue for us to

56 discuss the idea first.

59 ## Finally

61 Thanks again for your interest in improving the project! You're taking

62 action when most people decide to sit and watch.

madduck's git repository

Legalese