]>
git.madduck.net Git - etc/vim.git/blobdiff - docs/contributing/the_basics.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:
Install all development dependencies using:
```console
Install all development dependencies using:
```console
-$ 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 correct thing.
-
-Non pipenv install works too:
-
-```console
-$ pip install -r test_requirements
-$ pip install -e .[d]
+$ python3 -m venv .venv
+$ source .venv/bin/activate
+(.venv)$ pip install -r test_requirements.txt
+(.venv)$ pip install -e .[d]
+(.venv)$ pre-commit install
```
Before submitting pull requests, run lints and tests with the following commands from
```
Before submitting pull requests, run lints and tests with the following commands from
+(.venv) $ pre-commit run -a
# Optional CI run to test your changes on many popular python projects
# Optional CI run to test your changes on many popular python projects
-$ black-primer [-k -w /tmp/black_test_repos]
+(.venv) $ black-primer [-k -w /tmp/black_test_repos]
```
### News / Changelog Requirement
```
### News / Changelog Requirement
If you make changes to docs, you can test they still build locally too.
```console
If you make changes to docs, you can test they still build locally too.
```console
-$ pip install -r docs/requirements.txt
-$ pip install [-e] .[d]
-$ sphinx-build -a -b html -W docs/ docs/_build/
+(.venv) $ pip install -r docs/requirements.txt
+(.venv) $ pip install [-e] .[d]
+(.venv) $ sphinx-build -a -b html -W docs/ docs/_build/