mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-22 17:16:24 +00:00
Code Issues 25 Releases Wiki Activity

Doc'd a few contributing guidelines.

Browse Source
This commit is contained in:
Tim Graham 2019-03-25 18:26:23 -04:00 committed by GitHub
parent 624573726a
commit 9caa3e0a29
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/internals/contributing/committing-code.txt
View File

@ -135,9 +135,10 @@ Django's Git repository:
specific tasks. Added guidelines of how to use Git, GitHub, and
how to use pull request together with Trac instead.
If the patch wasn't a pull request, you should credit the contributors in
the commit message: "Thanks A for report, B for the patch and C for the
review."
Credit the contributors in the commit message: "Thanks A for the report and B
for review." Use git's `Co-Authored-By`_ as appropriate.
.. _Co-Authored-By: https://help.github.com/articles/creating-a-commit-with-multiple-authors/
* For commits to a branch, prefix the commit message with the branch name.
For example: "[1.4.x] Fixed #xxxxx -- Added support for mind reading."

3
docs/internals/contributing/writing-documentation.txt
View File

@ -208,6 +208,9 @@ documentation:
syntax, it won't be highlighted. Adding ``.. code-block:: python``, for
example, will force highlighting despite invalid syntax.
* To improve readability, use ``.. admonition:: Descriptive title`` rather than
``.. note::``. Use these boxes sparingly.
* Use these heading styles::
===