# Documentation Django 6.0.7

# Tri des tickets

Django utilise Trac pour gérer le travail sur le code source. Trac est un jardin communautaire où sont répertoriés les bogues trouvés par les utilisateurs et les fonctionnalités que Django a décidé d’ajouter. Comme dans tout jardin, il faut parfois arracher les mauvaises herbes et parfois cueillir les fleurs et les légumes. Nous avons besoin de votre aide pour faire le tri entre les deux pour qu’au final nous en profiterons tous ensemble.

Comme pour tout jardin, nous pouvons aspirer à la perfection, mais dans la réalité, elle n’existe jamais. Même dans les jardins les plus purs, il y a toujours des escargots et des insectes. Dans un jardin communautaire, il y a aussi des personnes voulant aider de manière bien intentionnée et qui fertilisent les graines et empoisonnent les roses. C’est la tâche de la communauté entière de s’autogérer, de limiter au mieux les problèmes et d’éduquer ceux qui arrivent dans la communauté afin qu’ils puissent devenir des membres contributifs de valeur.

De même, bien que nous visions que Trac soit une représentation parfaite de l’état de progression de Django, nous reconnaissons que cela n’arrivera pas. En distribuant la charge de maintenance de Trac à la communauté, nous acceptons qu’il y aura des erreurs. Trac est « majoritairement à jour » et nous assumons que dans certains cas il se trompe. Cela nous va. Nous sommes des perfectionnistes avec des délais !

Nous comptons sur la communauté pour qu’elle continue de participer, de garder les tickets dans un état le plus juste possible et qu’elle amène les sujets de discussion sur le forum Django lorsqu’il y a de la confusion ou des désaccords.

Django est un projet communautaire et chaque contribution est utile. Nous ne pouvons pas le faire sans vous !

## Procédures de tri des tickets

Malheureusement, tous les rapports dans le système de suivi des tickets ne fournissent pas tous les détails requis. Un certain nombre de tickets proposent des solutions, mais celles-ci ne répondent pas nécessairement à toutes les exigences respectant les directives de contribution.

Une manière d’aider est de « trier » des tickets que d’autres utilisateurs ont créés.

La plupart du flux de travail est basé autour du concept d’:ref:étapes de tri <triage-stages>` d’un ticket. Chaque étape définit le stade dans lequel se trouve un ticket dans sa durée de vie. En compagnie de quelques autres options à cocher, cet attribut indique de qui et de quoi dépend la suite de l’avancement du ticket.

Comme une image vaut mieux que mille mots, commençons par ceci :

We have four roles in this diagram. Maintainers (also known as Fellows) usually take part in all of them, but anyone in the Django community can participate in any role except merger. The merger role is granted by a vote of the Steering Council.

- Triagers: anyone can take on this role by checking whether a ticket describes a real issue and keeping the tracker organized.

- Bug fixers: anyone can contribute by opening a pull request and working on a solution for a ticket.

- Reviewers: anyone can review pull requests and suggest improvements.

- Mergers: people with commit access who make the final decision to merge a change.

When we say anyone, we mean you!

Our Trac system and GitHub repositories are intentionally open to the public. Anyone can help by working on tickets, triaging tickets and reviewing changes. Django is a community project, and we encourage triage and collaboration by the community. We truly want you to help!

For example, here’s the typical lifecycle of a ticket:

- Alice creates a ticket and opens an incomplete pull request (missing tests, incorrect implementation).

- Bob reviews the pull request, marks the ticket as « Accepted », sets the flags « needs tests » and « patch needs improvement », and leaves a comment explaining how Alice can improve the patch. This puts the ticket automatically into the « waiting on author » queue within the « accepted » stage.

- Alice updates the pull request, adding tests (but not yet fixing the implementation), and removes the two flags. The ticket moves into the « needs PR review » queue.

- Charlie reviews the pull request, sets the « patch needs improvement » flag again, and leaves another comment suggesting changes to the implementation. The ticket moves back to the « waiting on author » queue.

- Alice updates the pull request again, this time fixing the implementation, and removes the « patch needs improvement » flag. The ticket moves once more into the « needs PR review » queue.

- Daisy relit la demande de contribution et marque le ticket comme « Ready for checkin » (prêt pour l’intégration).

- Jacob, a merger, reviews and merges the pull request.

Some tickets move through these steps quickly, while others take more time and discussion. Each contribution helps Django improve.

## Étapes de tri

Nous décrivons ci-dessous plus en détails les diverses étapes par lesquelles un ticket passe durant son parcours de vie.

### Non traité (Unreviewed)

The ticket has not been reviewed by anyone who felt qualified to make a judgment about whether the ticket contained a valid issue or ought to be closed for any reasons. Unreviewed tickets appear in the « triage » queue.

Unreviewed tickets may receive additional refinement before being accepted. Unless you are both the author of the ticket and intending to submit a patch, unreviewed tickets should not be claimed.

### Accepté (Accepted)

The absolute meaning of « accepted » is that the issue described in the ticket is valid and actionable. It is broken out into three queues:

- Needs Patch (Accepted + No Flags)

  Le ticket est valide, mais personne n’a encore soumis de correctif pour celui-ci. Cela signifie souvent que vous pouvez commencer à rédiger un correctif en toute sécurité. Cela est généralement avéré pour des bogues acceptés que pour des fonctionnalités acceptées. Un ticket pour un bogue qui a été accepté signifie que le problème a été vérifié par au moins un trieur comme étant un bogue légitime et qu’il devrait probablement être corrigé si possible.

  Pour les nouvelles fonctionnalités, les tickets acceptés doivent exister après que l’idée ait suivi le `processus approprié pour suggérer de nouvelles fonctionnalités ` et reçu l’approbation de la communauté et du `Conseil de pilotage `, ou ait été acceptée dans un DEP.

- Needs PR Review (Accepted + Has Patch)

  Le ticket est en attente de personnes qui vont examiner la solution proposée. Cela implique de télécharger le correctif et l’essayer, en vérifiant qu’il contienne des tests et de la documentation, en lançant la suite de tests après l’application du correctif, et en indiquant son avis sur le ticket.

- Waiting On Author (Accepted + Has Patch + Needs fixes)

  Cela signifie que le ticket a été examiné, mais qu’il a été jugé nécessaire de le retravailler quelque peu. « Needs tests » et « Needs documentation » s’expliquent par eux-mêmes. « Patch needs improvement » est généralement accompagné d’un commentaire sur le ticket expliquant ce qui est nécessaire pour améliorer le code.

### Prêt pour le commit (Ready For Checkin)

Le ticket a été relu et examiné par tout membre de la communauté autre que la personne qui a fourni le correctif et l’examen n’a pas révélé de manquement qui empêcherait la contribution d’être prête au commit. Un fusionneur devra ensuite donner un dernier coup d’œil avant de procéder au commit.

Il y a beaucoup de requêtes de contribution. L’examen de votre correctif peut prendre du temps. Consultez la FAQ de contribution au code pour d’autres questions à ce sujet.

### Un jour peut-être (Someday/Maybe)

Cette étape n’apparaît pas sur le diagramme. Elle est utilisée avec parcimonie pour suivre les changements à long terme.

Ces tickets sont rares et globalement moins utiles, car ils ne décrivent pas de problèmes concrets pouvant faire l’objet d’une action.

## Autres attributs de tri

Un certain nombre de drapeaux, apparaissant sous forme de cases à cocher dans Trac, peuvent être définis pour un ticket :

### Has patch (possède un correctif)

Cela signifie qu’il y a une solution proposée sur le ticket. Cette solution devra être relue pour garantir qu’elle adhère aux lignes directrices documentées.

Les trois champs suivants (Needs documentation, Needs tests, Patch needs improvement) ne s’appliquent que lorsqu’un correctif est disponible.

### Needs documentation (a besoin de documentation)

Ce drapeau est utilisé pour les tickets ayant un correctif, mais pas encore de documentation. La documentation complète des fonctionnalités est un prérequis avant de pouvoir faire entrer du code dans Django.

### Needs tests (a besoin de tests)

Ce drapeau indique que le correctif a besoin de tests unitaires associés. Encore une fois, il s’agit d’un élément obligatoire pour une contribution valable.

### Patch needs improvement (le correctif a besoin d’améliorations)

Ce drapeau signifie que même si le ticket propose une solution, il n’est pas encore prêt à être commité. Cela peut signifier que le correctif n’est plus applicable, que son implémentation est défaillante ou que le code ne correspond pas aux standards exigés.

### Easy pickings (simple à corriger)

Désigne les tickets qui nécessitent de petits changements assez simples.

### Type

Les billets doivent être classés par type parmi :

- New Feature (nouvelle fonctionnalité)

    Pour ajouter quelque chose de nouveau.

- Bug

    Quand une chose existante est cassé ou n’a pas le fonctionnement attendu.

- Nettoyage/optimisation

    Lorsque rien n’est cassé mais quelque chose pourrait être plus propre, mieux, plus rapide, plus puissant.

### Component (composant)

Les tickets doivent être classés en composants indiquant quelle partie du code de Django ils concernent. Cela aide à organiser les tickets et à les rendre plus facilement retrouvables.

### Severity (sévérité)

L’attribut severity est utilisé pour identifier les tickets bloquants, c’est-à-dire des problèmes devant être absolument résolus avant de publier la prochaine version de Django. Typiquement, il s’agit de bogues provoquant des régressions en comparaison d’anciennes versions ou qui sont potentiellement la cause de pertes de données importantes. Cet attribut est assez rarement utilisé et la grande majorité des tickets possèdent un niveau de sévérité « normal ».

### Version

The version attribute indicates the earliest version in which the bug was reproduced. During triage, this field can be updated, but there is no need to make further updates when that version goes out of support. The field should not be reset to « dev » to show the issue still exists: instead, the tested commit hash can be noted in a comment.

### UI/UX

Ce drapeau est utilisé pour les tickets qui sont liés aux questions d’interface utilisateur et d’expérience d’utilisation. Par exemple, ce drapeau serait approprié pour des fonctionnalités de présentation à l’utilisateur dans les formulaires ou l’interface d’administration.

### Cc

Il est possible d’ajouter son nom d’utilisateur ou son adresse électronique dans ce champ pour être averti lorsque de nouvelles contributions sont apportées au ticket concerné.

### Keywords (mots-clés)

Avec ce champ, il est possible d’étiqueter un ticket par plusieurs mots-clés. Cela peut par exemple être utile pour grouper plusieurs tickets autour d’un même thème. Les mots-clés peuvent être séparés par des virgules ou des espaces. Les recherches par mot-clé cherchent un mot-clé dans toute l’expression. Par exemple, si on clique sur le mot-clé « form » d’un ticket, les résultats contiendront tous les tickets étiquetés avec des mots tels que « formset », « modelformset » ou « ManagementForm ».

## Fermeture de tickets

Lorsqu’un ticket a terminé son cycle de vie utile, il est temps de le fermer. Cependant, la fermeture d’un ticket est une grande responsabilité. Il faut être certain que le problème est réellement réglé, et il faut garder à l’esprit que celui qui a ouvert le ticket pourrait ne pas être heureux de voir son ticket fermé (sauf si une correction a été appliquée !). Si vous n’êtes pas sûr qu’un ticket doit être fermé, laissez un commentaire avec votre raisonnement.

Si vous fermez réellement un ticket, vous devez toujours vous assurer des éléments suivants :

- Être certain que le problème est résolu.

- Laisser un commentaire expliquant la décision de fermer le ticket.

- S’il existe une manière d’améliorer le ticket pour qu’il soit réouvert, le faire savoir.

- Si le ticket est un doublon, faire référence au ticket original. De même, ajouter une référence croisée en ajoutant un commentaire sur le ticket original, ce qui permet d’avoir accès à davantage d’informations sur le bogue signalé ou la fonctionnalité demandée.

- Soyez poli. Personne n’aime voir son ticket être fermé. Cela peut être frustrant et même décourageant. La meilleure manière d’éviter de détourner les gens de la contribution à Django est de rester poli et amical, et d’offrir des suggestions sur la manière d’améliorer le ticket ainsi que d’autres tickets à venir.

Un ticket peut être résolu de plusieurs façons :

- fixed (résolu)

    Utilisé quand un correctif a été intégré à Django et que le problème est réglé.

- invalid (non valide)

    Utilisé lorsque le ticket est jugé incorrect. Cela signifie que le problème du ticket est en fait le résultat d’une erreur de l’utilisateur ou que le problème décrit s’applique à un autre composant que Django, ou encore qu’il ne s’agit ni d’un signalement d’erreur, ni d’une demande d’amélioration (par exemple, certains utilisateurs débutants ouvrent des tickets pour des demandes de support).

- wontfix (ne sera pas résolu)

    Utilisé lorsque quelqu’un décide que cette requête n’est pas jugée digne d’être prise en compte dans Django. Il peut arriver qu’un ticket soit fermé comme « wontfix » avec une demande de lancer une discussion sur le forum Django s’il existe un désaccord avec l’explication fournie par la personne qui a fermé le ticket. D’autres fois, une discussion précède la fermeture du ticket. Utilisez toujours le forum pour obtenir un consensus avant de réouvrir un ticket fermé comme « wontfix ».

- needsnewfeatureprocess

    Used when the ticket merits a new feature, which will need to get community input and support. See the process for suggesting new features.

- duplicate (doublon)

    Utilisé lorsqu’un autre ticket recouvre le même problème. En fermant les tickets doublons, la discussion reste centralisée à un seul endroit, ce qui aide tout le monde.

- worksforme (marche pour moi)

    Utilisé lorsque le ticket ne contient pas assez de détails pour reproduire l’anomalie originale.

- needsinfo (besoin d’informations)

    Utilisé lorsque le ticket ne contient pas assez d’informations pour reproduire le problème signalé, mais qu’il est potentiellement valable. Le ticket devrait être réouvert après que des informations supplémentaires ont été fournies.

If you believe that the ticket was closed in error – because you’re still having the issue, or it’s popped up somewhere else, or the triagers have made a mistake – please reopen the ticket and provide further information. Again, please do not reopen tickets that have been marked as « wontfix » or « needsnewfeatureprocess ». For « wontfix » tickets, bring the issue to the Django Forum instead. For « needsnewfeatureprocess » tickets, propose the feature through the new features process.

## Commet puis-je aider au développement ?

Le processus de développement est principalement mené par des membres de la communauté. Vraiment, TOUT LE MONDE peut aider.

Pour vous impliquer, commencez par créer un compte sur Trac. 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.

Puis, vous pouvez aider en :

- Fermant les nouveaux tickets (« Unreviewed ») comme « invalid », « worksforme », « duplicate », « wontfix » ou « needsnewfeatureprocess ».

- Fermant les nouveaux tickets (« Unreviewed ») comme « needsinfo » lorsque la description est trop vague pour qu’on puisse imaginer une résolution concrète.

- Corrigeant les coches « Needs tests », « Needs documentation » ou « Has patch » pour les tickets où elles ne sont pas correctement définies.

- Activant la coche « Easy pickings » pour les tickets de faible portée et relativement évidents.

- Définissant le type des tickets qui ne sont pas encore catégorisés.

- Vérifiant que les anciens tickets sont toujours valables. SI un ticket n’a pas vu d’activité depuis longtemps, il est possible que le problème ait été résolu dans l’intervalle sans que le ticket ait été fermé.

- Identifiant des tendances et des thèmes dans les tickets. Si de nombreux signalements de bogues concernent une partie particulière de Django, cela peut indiquer que cette partie de code a besoin de réécriture. Si une tendance se dégage, il est suggéré d’amener une discussion (en faisant référence aux tickets concernés) sur le forum Django.

- Vérifiant si les solutions proposées par d’autres personnes sont correctes. Si elles sont correctes et qu’elles contiennent la documentation et les tests nécessaires, vous pouvez faire passer le ticket à l’état « Ready for Checkin ». Dans le cas contraire, écrivez un commentaire expliquant pourquoi et cochez les cases correspondantes (« Patch needs improvement », « Needs tests », etc.).

Note

La page des rapports contient des liens vers de nombreuses requêtes Trac utiles, y compris certaines orientées sur le triage des tickets et la relecture de propositions comme suggéré ci-dessus.

Vous pouvez aussi trouver plus de Conseils pour les nouveaux contributeurs.

Cependant, nous demandons à tous les membres de la communauté de respecter les principes suivants en travaillant sur la base de données des tickets :

- Please don’t promote your own tickets to « Accepted ». Another community member should review the report and set this stage after reproducing and confirming the issue.

- Please don’t promote your own tickets to « Ready for checkin ». You may mark other people’s tickets that you’ve reviewed as « Ready for checkin », but you should get at minimum one other community member to review a patch that you submit.

- S’il vous plaît, ne revenez pas sur une décision sans d’abord écrire un message sur le forum Django pour trouver un consensus.

- Si vous n’êtes pas certain de devoir faire une modification, ne la faites pas, mais laissez plutôt un commentaire avec vos préoccupations sur le ticket, ou écrivez un message sur le forum Django. Il est légitime de ne pas savoir, mais votre opinion compte tout de même.

## Recherche d’origine d’une régression avec bisect

Une régression est un bogue présent dans une version plus récente de Django et qui ne l’était pas avant. Un élément d’information extrêmement utile est le commit qui a introduit la régression. Le fait de connaître le commit qui est la cause du changement de comportement aide à découvrir si la modification était intentionnelle ou s’il s’agit d’un effet de bord inattendu. Voici comment vous pouvez trouver ce commit.

Commencez par écrire un test de régression du problème pour la suite de tests de Django. Par exemple, nous supposons que nous recherchons une régression dans les migrations. Après avoir écrit le test et confirmé que celui-ci échoue avec le code le plus récent (branche main), placez-le dans un fichier séparé que vous pouvez exécuter de manière indépendante. Pour notre exemple, nous supposons que nous avons placé le test dans le fichier `tests/migrations/test_regression.py`, qui peut être exécuté avec :

    $ ./runtests.py migrations.test_regression

Puis, nous marquons le point actuel dans l’historique comme « mauvais » (bad) dans la mesure où le test échoue :

    $ git bisect bad
    You need to start by "git bisect start"
    Do you want me to do it for you [Y/n]? y

Nous devons maintenant trouver un point dans l’historique git avant l’introduction de la régression (c’est-à-dire un point où le test passe). Utilisez quelque chose comme `git checkout HEAD~100` pour extraire une version du code précédente (100 commits dans le passé, dans ce cas). Vérifiez si le test passe ou échoue. S’il échoue, marquez ce point comme « mauvais » (`git bisect bad`), puis continuez d’extraire du code plus ancien et refaites le contrôle jusqu’à ce que vous trouviez un point d’historique où le test passe, et marquez alors ce point comme « bon » (good) :

    $ git bisect good
    Bisecting: X revisions left to test after this (roughly Y steps)
    ...

Nous sommes maintenant prêt pour la partie sympa : utilisez `git bisect run` pour automatiser la suite du processus :

    $ git bisect run tests/runtests.py migrations.test_regression

Vous devriez voir `git bisect` utiliser une recherche binaire pour extraire automatiquement les révisions entre les bons et mauvais commits jusqu’à ce qu’il trouve le premier commit « mauvais » où le test échoue.

À ce stade, reportez vos résultats sur le ticket Trac et ajoutez le test de régression en pièce jointe. Lorsque quelqu’un écrira une correctif pour ce problème, il disposera déjà de votre test comme point de départ.

## Reviewing patches

A great way to learn the Django codebase is to help review patches. It allows you to focus on a fixed scope of Django with a particular perspective. Plus, Django tends to receive more patches than it can review which causes the review queue to build up. Contributors can help Django tremendously by reviewing patches.

The review queue is defined by tickets in Trac that are in the « Accepted » state with the flag « has patch » set and the flags « patch needs improvement », « needs tests » and « needs documentation » unset. There is also a set of Pull Requests in GitHub with the « no ticket » label that can be reviewed.

### Code review process

The general process to reviewing a patch for Django is as follows:

1. Pick a patch to review. This can be from the review queue or the Pull Requests in GitHub with the « no ticket » label. If you’re new, pick a specific component to stick with. Django is a big codebase, so it’s best to contribute consistently with a narrow focus and grow it slowly.

2. Pull the branch. See the Gestion des requêtes de contribution, including the git alias to make checking out other pull requests easier.

3. Check the tests. If the ticket is for a bug, there should be a regression test. Confirm that the test fails if the change is reverted. Check that the tests are adequately covering the code and logic as well. See Liste de contrôle de contribution.

4. Test in your own Django project. See Installation de la version de développement for how. Explore the user interface and user experience with the change. Does it feel right? Can you break it? Another approach is to assume everything is wrong. Can you demonstrate to yourself that each piece is correct?

5. Check the documentation. Is the documentation understandable? Does it provide the information the reader needs at that moment? Does it read well? Is it consistent with the documentation before and after it? See Construction locale de la documentation.

6. Are you happy with the patch? This is fairly subjective, but that’s fine. You should ask, does the approach make sense to you and is there another way to do it that’s better? Also ask yourself, is the scope of the change appropriate? Are things named appropriately? Renaming things is slow and challenging in Django, so we should try to get it right from the start. Are there backwards compatibility concerns? Lastly, are there any other general concerns such as things that may worry you or that should be looked into?

7. Review your feedback. Before you submit your feedback, consider the feedback you want to share. It takes courage to open a Pull Request, we should be thoughtful and considerate of the leap the author has made. If there are nitpicky or small suggestions, use GitHub’s suggestion feature. If the approach isn’t what you expected, consider asking the author why before requesting several changes. Seek to understand their reasoning first.

8. Submit feedback on GitHub and update flags, « patch needs improvement », « needs tests », and « needs documentation », as needed. This will move the ticket to the « waiting for author » queue. If you have given a specific type of code review, please indicate that on the Pull Request.

### Types of code reviews

Not everyone will or should give the same type of code review. Having a diverse set of opinions and experiences helps Django be better. If you are providing a specific review, please indicate that on the Pull Request in GitHub. Below are some of the types of code review you can perform:

- Accessibility review. Does it conform to our Accessibility standards?

- Patch style and contribution process review.

- Usability and developer experience review.

  - Use the change and provide feedback from that experience.

  - Are the APIs and documentation accessible and well explained?

- Domain expertise review. Do you have a personal expertise that is relevant such as databases, HTTP, security, etc?

- Benchmarking and performance review. There are benchmarking tests, but sometimes changes require additional testing.

  - Utilize Tests de performance django-asv to check performance over time.

  - Run benchmark tests by labeling the pull request with « benchmark ».