浏览代码

Added contributor guidelines for performance optimizations.

Sarah Boyce 8 月之前
父节点
当前提交
2c024c9ac0

+ 9 - 0
docs/internals/contributing/bugs-and-features.txt

@@ -117,6 +117,15 @@ branch, and show us your work!
 
 See also: :ref:`documenting-new-features`.
 
+Requesting performance optimizations
+====================================
+
+Reports of a performance regression, or suggested performance optimizations,
+should provide benchmarks and commands for the ticket triager to reproduce.
+
+See the :ref:`django-asv-benchmarks` for more details of Django's existing
+benchmarks.
+
 .. _how-we-make-decisions:
 
 How we make decisions

+ 18 - 0
docs/internals/contributing/writing-code/submitting-patches.txt

@@ -257,6 +257,24 @@ JavaScript contributions
 For information on JavaScript contributions, see the :ref:`javascript-patches`
 documentation.
 
+Optimization patches
+====================
+
+Patches aiming to deliver a performance improvement should provide benchmarks
+showing the before and after impact of the patch and sharing the commands for
+reviewers to reproduce.
+
+.. _django-asv-benchmarks:
+
+``django-asv`` benchmarks
+-------------------------
+
+`django-asv`_ monitors the performance of Django code over time. These
+benchmarks can be run on a pull request by labeling the pull request with
+``benchmark``. Adding to these benchmarks is highly encouraged.
+
+.. _django-asv: https://github.com/django/django-asv/
+
 .. _patch-review-checklist:
 
 Contribution checklist