# Documentation Django 5.2.8

# Soumission de contributions

Nous sommes toujours reconnaissants pour toute contribution au code de Django. Il est vrai que les rapports de bogue avec contribution associée seront résolus bien plus rapidement que ceux sans solution proposée.

## Corrections orthographiques et modifications de documentation

Si vous corrigez un problème vraiment trivial, par exemple en changeant un mot dans la documentation, la manière préférée de soumettre un correctif est de passer par les requêtes de contribution GitHub sans ouvrir un ticket Trac.

See the Travailler avec Git et GitHub for more details on how to use pull requests.

## « Appropriation » de tickets

Dans un projet de logiciel libre avec des centaines de contributeurs de par le monde, il est important de gérer efficacement la communication afin que le travail ne soit pas fait en double et que les contributions soient aussi efficaces que possible.

Ainsi donc, notre politique demande que les contributeurs « réclament » les tickets pour informer les autres développeurs qu’un bogue ou une fonctionnalité particulière est en cours de travail.

Si vous avez identifié une contribution que vous souhaiteriez apporter et que vous pensez en être capable (en fonction de vos capacités de codage, votre connaissance du fonctionnement de Django et vos disponibilités de temps), signalez-le en suivant ces étapes :

- Connectez-vous avec votre compte GitHub ou créez un compte dans notre système de tickets. Si vous disposez d’un compte mais que vous avez oublié le mot de passe, vous pouvez le réinitialiser en utilisant la page de réinitialisation de mot de passe.

- If a ticket for this issue doesn’t exist yet, create one in our ticket tracker. Remember that proposals for new features should follow the process for suggesting new features.

- Si un ticket pour ce problème existe déjà, assurez-vous que personne ne s’en occupe déjà. Pour cela, examinez la section `Owned by` du ticket. S’il est attribué à `nobody`, c’est qu’il est disponible. Sinon, quelqu’un d’autre est probablement en train de travailler sur ce ticket. Cherchez alors un autre bogue ou fonctionnalité ou contactez le développeur travaillant sur le ticket pour offrir votre aide. Si un ticket est attribué à quelqu’un depuis des semaines ou mois sans activité, il peut sans doute vous être attribué sans risque de conflit.

- Connectez-vous si ce n’est pas déjà fait, en cliquant sur « GitHub Login » ou « DjangoProject Login » dans la partie supérieure gauche de la page du ticket. Une fois connecté, vous pouvez cliquer sur le bouton « Modifier le ticket » au bas de la page.

- Attribuez-vous le ticket en cliquant sur le bouton radio « assign to » dans la section « Action ». Votre nom d’utilisateur sera ajouté par défaut dans la zone de texte.

- Pour terminer, cliquez sur le bouton « Submit changes » au bas de la page pour enregistrer.

Note

La fondation Django Software demande que toutes les personnes contribuant plus qu’un changement mineur dans Django signent et envoient un accord de licence de contribution. Ceci assure que la fondation Django Software possède des licences claires pour toutes les contributions permettant ainsi une licence claire pour tous les utilisateurs.

### Responsabilité des « possesseurs » de tickets

Après vous être attribué un ticket, vous avez la responsabilité de travailler sur ce ticket dans un temps raisonnable. Si vous n’avez plus de temps à y consacrer, désattribuez le ticket… ou éviter de vous l’attribuer en premier lieu !

S’il n’y a aucun signe de progression sur un ticket attribué durant une ou deux semaines, un autre développeur peut demander que vous cédiez l’attribution afin qu’il ne soit plus monopolisé et que quelqu’un d’autre puisse s’y atteler.

Si vous vous êtes attribué un ticket et qu’il prenne beaucoup de temps à coder (des jours ou semaines), mettez tout le monde au courant en écrivant des commentaires sur le ticket. Si vous ne fournissez pas des mises à jour régulières et que vous ne répondez pas à une demande de rapport de progression, il est possible que le ticket soit attribué à quelqu’un d’autre.

Comme toujours, mieux vaut trop communiquer que pas assez !

### Quels sont les tickets qui devraient être attribués ?

Passer par l’étape d’attribution de tickets est parfois surfait.

Dans le cas de petits changements tels que des corrections orthographiques de la documentation ou de petits bogues qui ne prennent que quelques minutes à corriger, vous n’avez pas besoin de passer par la gymnastique d’attribution des tickets. Soumettez directement vos modifications et voilà !

Il est toujours acceptable d’ajouter des liens vers des propositions dans un ticket si vous avez une proposition déjà prête, que le ticket soit attribué à quelqu’un ou pas.

## Style de contribution

Assurez-vous que toute contribution remplit au minimum les exigences suivantes :

- The code required to fix a problem or add a feature is an essential part of a solution, but it is not the only part. A good fix should also include a regression test to validate the behavior that has been fixed and to prevent the problem from arising again. Also, if some tickets are relevant to the code that you’ve written, mention the ticket numbers in some comments in the test so that one can easily trace back the relevant discussions after your patch gets committed, and the tickets get closed.

- Si le code ajoute une nouvelle fonctionnalité ou modifie le comportement d’une fonctionnalité existante, la modification doit aussi contenir de la documentation.

When you think your work is ready to be reviewed, send a GitHub pull request. If you can’t send a pull request for some reason, you can also use patches in Trac. When using this style, follow these guidelines.

- Envoyez des correctifs dans le format renvoyé par la commande `git diff`.

- Liez les correctifs à un ticket du système de suivi des tickets en utilisant le bouton « Attach file ». Évitez s’il-vous-plaît de placer un correctif dans la description ou dans un commentaire du ticket, sauf si le correctif contient une seule ligne.

- Nommez le fichier du correctif avec une extension `.diff` ; cela permettra au système des tickets d’appliquer une coloration syntaxique correcte, ce qui est très utile.

Quelle que soit la manière de soumettre votre travail, respectez ces étapes.

- Assurez-vous que votre code remplisse les exigences décrites dans notre liste de contrôle de contribution.

- Cochez la case « Has patch » sur le ticket et vérifiez que les cases « Needs documentation », « Needs tests » et « Patch needs improvement » ne sont pas cochées. Cela fait que le ticket apparaît dans la file d’attente « Patches needing review » dans le tableau de bord de développement.

## Contributions demandant un retour de la communauté

Une discussion dans la communauté élargie est nécessaire lorsqu’un correctif introduit une nouvelle fonctionnalité Django et donne ainsi lieu à une forme de décision conceptuelle. C’est particulièrement important quand l’approche choisie implique une obsolescence ou introduit des modifications disruptives.

Voici différentes approches pour obtenir des retours de la communauté.

### The new feature ideas tracker

If you have an idea for a new feature, please create a new proposal (or join an existing discussion) following the process for suggesting new features. You should explain the need for the change, go into details of the approach and discuss alternatives.

### Le forum Django

You can propose a change (that is not a new feature idea) on the Django Forum. You should explain the need for the change, go into details of the approach and discuss alternatives.

Nous vous prions d’inclure un lien vers ces discussions dans vos contributions.

### Paquet de tierce partie

Django n’accepte pas de fonctionnalités expérimentales. Toutes les fonctionnalités doivent suivre notre politique d’obsolescence. Cela signifie qu’il peut se passer des mois ou des années pour que Django modifie l’API d’une fonctionnalité.

Si vous attendez un retour d’utilisation sur une interface publique, il est préférable de créer d’abord un paquet tiers. Il est possible d’ajuster l’API publique de manière bien plus rapide tout en validant le besoin réel de la fonctionnalité.

Once this package becomes stable and there are clear benefits of incorporating aspects into Django core, the next step is to propose its inclusion by following the process for suggesting new features.

### Proposition d’amélioration de Django (DEP)

Sur le modèle des PEP de Python, Django possède un concept de propositions d’améliorations appelées DEP (Django Enhancement Proposals). Une DEP est un document conceptuel fournissant des informations à la communauté Django ou décrivant une fonctionnalité ou un processus nouveaux pour Django. Elles présentent de brèves spécifications techniques de fonctionnalités, accompagnées des motivations du besoin. Les DEP sont également le mécanisme principal pour proposer et collecter des avis de la communauté sur de nouvelles fonctionnalités majeures.

Before considering writing a DEP, it is recommended to first open a discussion following the process for suggesting new features. This allows the community to provide feedback and helps refine the proposal. Once the DEP is ready the Steering Council votes on whether to accept it.

Voici quelques exemples de DEP approuvées et complètement implémentées :

- DEP 181 : Expressions de l’ORM

- DEP 182 : Moteurs de gabarit multiples

- DEP 201 : Syntaxe de routage simplifée

## Obsolescence d’une fonctionnalité

Il existe plusieurs raisons pour que du code Django soit rendu obsolète :

- Si une fonctionnalité a été améliorée ou modifiée de manière non rétrocompatible, l’ancienne fonctionnalité ou comportement sera rendu obsolète.

- Il peut arriver que Django inclue un rétroportage d’une bibliothèque Python qui ne fait pas encore partie d’une version de Python prise en charge actuellement par Django. Lorsque Django n’a plus besoin de prendre en charge l’ancienne version de Python qui nécessitait d’inclure cette bibliothèque, l’inclusion de celle-ci sera rendue obsolète dans Django.

En accord avec la politique d’obsolescence, la première publication de Django qui rend obsolète une fonctionnalité (A.B`) doit produire un avertissement `RemovedInDjangoXXWarning` (où XX est la version de Django où la fonctionnalité sera supprimée) au moment où la fonctionnalité obsolète est appelée. Partant du principe que la couverture de tests est bonne, ces avertissements sont convertis en erreurs lorsque la suite de test est lancée <running-unit-tests> avec les avertissements activés : `python -Wa runtests.py`. Ainsi, quand vous ajoutez un avertissement `RemovedInDjangoXXWarning`, il est nécessaire d’éliminer ou de rendre silencieux tout avertissement produit lors de l’exécution des tests.

La première étape est d’enlever toute utilisation du comportement obsolète par Django lui-même. Ensuite, vous pouvez rendre silencieux les avertissements dans les tests qui testent la fonctionnalité obsolète en utilisant le décorateur `ignore_warnings`, soit au niveau d’un test isolé, soit sur une classe de tests :

1. Pour un test particulier

       from django.test import ignore_warnings
       from django.utils.deprecation import RemovedInDjangoXXWarning

       @ignore_warnings(category=RemovedInDjangoXXWarning)
       def test_foo(self): ...

2. Pour tout un cas de test

       from django.test import ignore_warnings
       from django.utils.deprecation import RemovedInDjangoXXWarning

       @ignore_warnings(category=RemovedInDjangoXXWarning)
       class MyDeprecatedTests(unittest.TestCase): ...

Vous devriez aussi ajouter un test pour l’avertissement d’obsolescence

    from django.utils.deprecation import RemovedInDjangoXXWarning

    def test_foo_deprecation_warning(self):
        msg = "Expected deprecation message"
        with self.assertWarnsMessage(RemovedInDjangoXXWarning, msg) as ctx:
            # invoke deprecated behavior
            ...
        self.assertEqual(ctx.filename, __file__)

Il est important d’inclure un commentaire `RemovedInDjangoXXWarning` au-dessus du code qui ne possède pas de référence vers un avertissement, mais qui devra être modifié ou supprimé à la fin de la période d’obsolescence. Cela pourrait concerner des points d’entrée qui auraient été ajoutés pour conserver le comportement précédent ou des éléments autonomes qui deviennent inutiles à la fin de la période d’obsolescence. Par exemple

    import warnings
    from django.utils.deprecation import RemovedInDjangoXXWarning, django_file_prefixes

    # RemovedInDjangoXXWarning.
    def old_private_helper():
        # Helper function that is only used in foo().
        pass

    def foo():
        warnings.warn(
            "foo() is deprecated.",
            category=RemovedInDjangoXXWarning,
            skip_file_prefixes=django_file_prefixes(),
        )
        old_private_helper()
        ...

Pour terminer, il reste à appliquer quelques mises à jour de la documentation Django :

1. Si la fonctionnalité existante est documentée, marquez-la comme obsolète dans la documentation en utilisant l’annotation `.. deprecated:: A.B`. Ajoutez une courte description ainsi qu’une note sur la procédure de mise à jour le cas échéant.

2. Ajoutez une description du comportement obsolète et la procédure de mise à jour le cas échéant aux notes de publication actuelles (`docs/releases/A.B.txt`) sous le chapitre « Features deprecated in A.B ».

3. Ajoutez une ligne dans la planification d’obsolescence (`docs/internals/deprecation.txt`) sous la version adéquate en indiquant le code qui sera supprimé.

Après avoir accompli ces étapes, le procédé d’obsolescence est terminé. Dans chaque publication principale, tous les avertissements `RemovedInDjangoXXWarning` correspondant à la nouvelle version sont supprimés.

The `django.utils.deprecation` module provides some helpful deprecation utilities, such as a `@deprecate_posargs` decorator to assist with converting positional-or-keyword arguments to keyword-only. See the inline documentation in the module source.

## Testing with a Django project

It’s important to test local changes using a Django project. This allows ensuring that the changes behave as expected in a real environment, especially for user-facing features such as templates, forms, or the admin.

To do this:

1. Create a virtual environment and install the cloned copy of Django in editable mode.

2. Set up a Django project outside the source tree (you can use the first part of the tutorial for guidance).

With this setup, any changes made to the Django checkout will take effect immediately in the test project, allowing manual testing of contributions against a new or existing app.

## Contributions JavaScript

Pour des informations sur les contributions JavaScript, consultez la documentation Correctifs JavaScript.

## Optimisation des correctifs

Les correctifs visant à produire une amélioration de performance doivent fournir des tests de performance démontrant l’impact avant et après le correctif et partager les commandes pour que les relecteurs puissent les reproduire.

### Tests de performance `django-asv`

django-asv surveille la performance du code de Django au cours du temps. Ces tests peuvent être exécutés sur une requête de contribution en étiquetant la requête avec le mot `benchmark`. L’ajout de nouveaux tests de performance est hautement encouragé.

## Liste de contrôle de contribution

Use this checklist to review a pull request. If this contribution would not be considered trivial, first ensure it has an accepted ticket before proceeding with the review.

If the pull request passes all the criteria below and is not your own, please set the « Triage Stage » on the corresponding Trac ticket to « Ready for checkin ». If you’ve left comments for improvement on the pull request, please tick the appropriate flags on the Trac ticket based on the results of your review: « Patch needs improvement », « Needs documentation », and/or « Needs tests ». As time and interest permits, mergers do final reviews of « Ready for checkin » tickets and will either commit the changes or bump it back to « Accepted » if further work needs to be done.

If you’re looking to become a member of the triage & review team, doing thorough reviews of contributions is a great way to earn trust.

En recherche d’un correctif à relire ? Consultez la section « Patches needing review » du tableau de bord de développement de Django.

Vous recherchez une relecture pour votre requête de contribution ? Assurez-vous que les drapeaux Trac sur le ticket correspondant soient bien définis afin que le ticket apparaisse dans cette file d’attente.

### Documentation

- Est-ce que la documentation peut être construite sans erreur (`make html` ou `make.bat html` sur Windows, à partir du répertoire `docs`) ?

- Est-ce que la documentation respecte les lignes directrices de style d’écriture de Écrire la documentation?

- Y a-t-il des fautes d’orthographe?

### Bogues

- Y a-t-il un test de régression approprié (le test doit échouer avant l’application de la correction) ?

- S’il s’agit d’un bogue qui est susceptible d’être rétroporté vers la version stable de Django, existe-t-il une note de publication dans `docs/releases/A.B.C.txt`? Les corrections de bogues qui ne s’appliquent qu’à la branche `main` n’ont pas besoin d’une note de publication.

### Nouvelles fonctionnalités

- Y a-t-il des tests qui « éprouvent » la totalité du nouveau code ?

- Existe-t-il une note de publication dans `docs/releases/A.B.txt`?

- La fonctionnalité est-elle documentée et est-elle annotée convenablement avec `.. versionadded:: A.B` ou `.. versionchanged:: A.B`?

### Obsolescence d’une fonctionnalité

Consultez le guide Obsolescence d’une fonctionnalité.

### Toutes les modifications de code

- Does the coding style conform to our guidelines? Are there any `black`, `blacken-docs`, `flake8`, `isort`, or `zizmor` errors? You can install the pre-commit hooks to automatically catch these errors.

- Si la modification n’est pas rétrocompatible d’une quelconque manière, existe-t-il une note de publication appropriée (dans `docs/releases/A.B.txt`) ?

- Est-ce que la suite de tests de Django passe ?

- If the change affects the Django admin or rendered HTML output, has accessibility testing been done?

### Tous les tickets

- La requête de contribution est-elle un seul commit fusionné avec un message respectant notre format des messages de commit?

- Êtes-vous l’auteur du commit et un nouveau contributeur ? Veuillez vous ajouter dans le fichier AUTHORS et soumettre un Contributor License Agreement (accord de licence de contribution).

- Does this have an accepted ticket on Trac? All contributions require a ticket unless the change is considered trivial.