X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/c758126a270bb5a78513f3f07ddd60bc4aacf4a4..95c03b9638e44eb76611a0e005d447472a4f2f97:/docs/contributing/the_basics.md?ds=inline diff --git a/docs/contributing/the_basics.md b/docs/contributing/the_basics.md index d9df0ea..23fbb8a 100644 --- a/docs/contributing/the_basics.md +++ b/docs/contributing/the_basics.md @@ -7,7 +7,8 @@ An overview on contributing to the _Black_ project. Development on the latest version of Python is preferred. As of this writing it's 3.9. You can use any operating system. -Install all development dependencies using: +Install development dependencies inside a virtual environment of your choice, for +example: ```console $ python3 -m venv .venv @@ -54,7 +55,9 @@ go back and workout what to add to the `CHANGES.md` for each release. If a change would affect the advertised code style, please modify the documentation (The _Black_ code style) to reflect that change. Patches that fix unintended bugs in -formatting don't need to be mentioned separately though. +formatting don't need to be mentioned separately though. If the change is implemented +with the `--preview` flag, please include the change in the future style document +instead and write the changelog entry under a dedicated "Preview changes" heading. ### Docs Testing