Soumission de correctifs

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

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.

Consultez Travailler avec Git et GitHub pour plus de détails sur la manière d’utiliser les requêtes de contribution (« 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.
  • Si un ticket pour ce problème n’existe pas encore, créez-en un dans notre système de suivi des tickets.
  • 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.
  • Attribuez-vous le ticket en cliquant sur le bouton radio « assign to myself » sous « Action » près du bas de la page, puis cliquez sur « Submit changes ».

Note

La fondation Django Software demande que toutes les personnes contribuant plus qu’un correctif 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 votre correctif et voilà !

Il est toujours acceptable de soumettre des correctifs à un ticket si vous avez un correctif déjà prêt, que le ticket soit attribué à quelqu’un ou pas.

Style des correctifs

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

  • Le code exigé pour corriger un problème ou ajouter une fonctionnalité est une partie essentielle d’un correctif, mais ce n’est pas la seule partie. Un bon correctif doit aussi comprendre un test de régression pour valider le comportement ayant été corrigé et empêcher le problème de se reproduire à nouveau. De même, si d’autres tickets sont liés au code que vous avez écrit, mentionnez les numéros de tickets dans des commentaires de tests afin que l’on puisse aisément se référer aux discussions appropriées après que votre correctif aura été intégré et que les tickets auront été fermés.
  • Si le code associé à un correctif ajoute une nouvelle fonctionnalité ou modifie le comportement d’une fonctionnalité existante, le correctif doit aussi contenir de la documentation.

Lorsque vous pensez que votre travail est prêt à être relu, envoyez une requête de contribution GitHub. Veuillez préalablement relire vous-même le correctif en utilisant notre liste de contrôle de relecture des correctifs.

Si vous ne pouvez envoyer de requête de contribution pour une raison quelconque, vous pouvez aussi envoyer un correctif dans Trac. Si vous utilisez cette méthode, veuillez suivre les lignes directrices suivantes.

  • 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 relecture des correctifs.
  • 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.

Correctifs non triviaux

Un correctif non trivial est un correctif qui dépasse la correction d’une anomalie simple. Il introduit une fonctionnalité Django et implique un certain degré de choix conceptuel.

Si vous fournissez un correctif non trivial, présentez des preuves que des alternatives ont été discutées sur le forum Django ou la liste django-developers.

SI vous n’êtes pas certain que votre correctif peut être considéré comme trivial, discutez-en dans le ticket pour récolter d’autres avis.

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):
        # invoke deprecated behavior
        ...

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


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


def foo():
    warnings.warn(
        "foo() is deprecated.",
        category=RemovedInDjangoXXWarning,
    )
    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.

Correctifs JavaScript

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

Liste de contrôle de révision des correctifs

Utilisez cette liste de contrôles pour relire une requête de contribution. Si vous relisez une requête de quelqu’un d’autre et qu’elle remplit tous les critères ci-dessous, veuillez définir la valeur « Triage Stage » du ticket Trac correspondant à « Ready for checkin ». Si vous avez écrit des commentaires d’amélioration sur la requête de contribution, veuillez cocher les options correspondantes du ticket Trac selon les résultats de votre relecture : « Patch needs improvement », « Needs documentation » et/ou « Needs tests ». Selon le temps et l’envie, les fusionneurs effectuent une relecture finale des tickets « Ready for checkin » et vont soit commiter le correctif, soit le renvoyer en statut accepté s’il manque encore certains éléments. Si vous espérez devenir fusionneur, le fait d’effectuer de sérieuses relectures de correctifs est un bon moyen de gagner de la confiance.

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 correctif ? 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

  • Le style de code correspond-il à nos standards ? Y a-t-il des erreurs black, blacken-docs, flake8 ou isort? Vous pouvez installer les crochets ref:pre-commit <coding-style-pre-commit> pour intercepter automatiquement ces erreurs.
  • 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 ?

Tous les tickets

Back to Top