mirror of
https://github.com/cookiecutter/cookiecutter-django.git
synced 2025-07-29 17:29:45 +03:00
update documentation, fix some spacing issues
This commit is contained in:
parent
e4f2a83e6a
commit
78ddd2df8a
|
@ -50,6 +50,7 @@ Optional Integrations
|
|||
|
||||
* Serve static files from Amazon S3 or Whitenoise_
|
||||
* Configuration for Celery_
|
||||
* Configuration for Precommit-Hooks_
|
||||
* Integration with MailHog_ for local email testing
|
||||
* Integration with Sentry_ for error logging
|
||||
* Integration with NewRelic_ for performance monitoring
|
||||
|
@ -72,7 +73,7 @@ Optional Integrations
|
|||
.. _docker-compose: https://www.github.com/docker/compose
|
||||
.. _Opbeat: https://opbeat.com/
|
||||
.. _PythonAnywhere: https://www.pythonanywhere.com/
|
||||
|
||||
.. _Precommit-Hooks_: http://pre-commit.com/
|
||||
|
||||
Constraints
|
||||
-----------
|
||||
|
@ -128,7 +129,6 @@ Answer the prompts with your own desired options_. For example::
|
|||
use_heroku [n]: n
|
||||
use_grunt [n]: y
|
||||
use_precommit_hooks [n]: n
|
||||
|
||||
Select open_source_license:
|
||||
1 - MIT
|
||||
2 - BSD
|
||||
|
|
|
@ -73,6 +73,26 @@ Please note: For Celery's import magic to work, it is important *where* the cele
|
|||
|
||||
{% endif %}
|
||||
|
||||
{% if cookiecutter.use_precommit_hooks == "y" %}
|
||||
|
||||
Pre-Commit Hooks
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
To use pre-commit hooks when committing messages, after initial git commit, run
|
||||
.. code-block:: bash
|
||||
|
||||
pre-commit install
|
||||
|
||||
Now on each commit message, this will run whatever commit plugins have been enabled. To skip a pre-commit hook, add a -n (no verify) parameter at the end of your commit message.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
git commit -m "i put a really bad pdb in here" -n
|
||||
|
||||
|
||||
{% endif %}
|
||||
|
||||
|
||||
{% if cookiecutter.use_mailhog == "y" %}
|
||||
|
||||
Email Server
|
||||
|
|
Loading…
Reference in New Issue
Block a user