diff options
| author | Sarah Boyce <42296566+sarahboyce@users.noreply.github.com> | 2024-07-02 17:49:25 +0200 |
|---|---|---|
| committer | Sarah Boyce <42296566+sarahboyce@users.noreply.github.com> | 2024-07-25 09:28:15 +0200 |
| commit | d9d77de2f6b417dd3c9d01a6f3879c37482be725 (patch) | |
| tree | 5dfe497e228026886c7b402d4b3dbccba632c158 /docs | |
| parent | d8116bf7f56930a95926444c625ca786f2f534ce (diff) | |
[5.1.x] Added contributor guidelines for performance optimizations.
Backport of 2c024c9ac096d06d9e78d1ae02b52f73a45eadf8 from main.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/internals/contributing/bugs-and-features.txt | 9 | ||||
| -rw-r--r-- | docs/internals/contributing/writing-code/submitting-patches.txt | 18 |
2 files changed, 27 insertions, 0 deletions
diff --git a/docs/internals/contributing/bugs-and-features.txt b/docs/internals/contributing/bugs-and-features.txt index b6b3265ba6..52cde58531 100644 --- a/docs/internals/contributing/bugs-and-features.txt +++ b/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 diff --git a/docs/internals/contributing/writing-code/submitting-patches.txt b/docs/internals/contributing/writing-code/submitting-patches.txt index 11a96eb911..2d61c6235e 100644 --- a/docs/internals/contributing/writing-code/submitting-patches.txt +++ b/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 |