From 9caa3e0a29c54939cc923c1693f491ff6c8e77e2 Mon Sep 17 00:00:00 2001
From: Tim Graham <timograham@gmail.com>
Date: Mon, 25 Mar 2019 18:26:23 -0400
Subject: [PATCH] Doc'd a few contributing guidelines.
---
docs/internals/contributing/committing-code.txt | 7 ++++---
docs/internals/contributing/writing-documentation.txt | 3 +++
2 files changed, 7 insertions(+), 3 deletions(-)
diff --git a/docs/internals/contributing/committing-code.txt b/docs/internals/contributing/committing-code.txt
index cc1d29c521..d66c44180f 100644
--- a/docs/internals/contributing/committing-code.txt
+++ b/docs/internals/contributing/committing-code.txt
@@ -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."
diff --git a/docs/internals/contributing/writing-documentation.txt b/docs/internals/contributing/writing-documentation.txt
index 47ea4c589c..acd8a3743b 100644
--- a/docs/internals/contributing/writing-documentation.txt
+++ b/docs/internals/contributing/writing-documentation.txt
@@ -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::
===