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:25:25 +0200 |
| commit | 2c024c9ac096d06d9e78d1ae02b52f73a45eadf8 (patch) | |
| tree | f4fddb6a2d0a5c2aa7f6fd1bbc626f8f09a95d9c /docs/internals/contributing/writing-code | |
| parent | cd0479ff764272add5e0aba2afcf5649a241ca00 (diff) | |
Added contributor guidelines for performance optimizations.
Diffstat (limited to 'docs/internals/contributing/writing-code')
| -rw-r--r-- | docs/internals/contributing/writing-code/submitting-patches.txt | 18 |
1 files changed, 18 insertions, 0 deletions
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 |