La dernière mise à jour de cette page été effectuée en 2020-05.

Veuillez lire le guide pour nouveaux développeurs d’abord.

Directives de base et style de programmation

La plupart des points suivants devraient être évident pour quelqu’un qui a travaillé sur du code source libre ou dans une environnement commercial de programmation. Les points suivants s’appliquent surtout à la branche de développement principale i2p.i2p. Les directives pour d’autres branches, plug-ins et applications externes peuvent être considérablement différentes, vérifiez avec le développeur approprié pour des conseils.

Communauté

  • Please don't just "write code". If you can, participate in other development activities, including: development discussions and support on IRC, zzz.i2p, and i2pforum.i2p; testing; bug reporting and responses; documentation; code reviews; etc.
  • Les dévs actif devrait être disponible périodiquement sur IRC #i2p-dev. Soyez au courant du cycle de sortie actuel. Adhérez pour relâcher - release - des jalons - milestones - tel que gel de caractéristiques, gel d’étiquette et le délai limite pour une sortie.

Cycle de sortie

Our normal release cycle is 6-12 weeks. Following are the approximate deadlines within a typical 8-week cycle. Actual deadlines for each release are set by the lead developer after consultation with the full team.

  • 1 à 2 jours après la version sortie précédemment : les inclusions (checkins) vers le tronc (trunk) sont permises.
  • 2–3 semaines après la version sortie précédemment  : délai limite pour propager les changements majeurs depuis d’autres branches vers le tronc.
  • 4–5 semaines avant la sortie : délai limite concernant les demandes d’ajouts de liens sur la page d’accueil.
  • 3 à 4 semaines avant la sortie : gel des caractéristiques. Échéance pour les nouvelles fonctions principales.
  • 2 à 3 semaines avant la sortie : tenue d’une réunion de projet afin de passer en revue les requêtes de mise en page d’accueil, si il y en a.
  • 10-14 days before release: String freeze. No more changes to translated ("tagged") strings. Push strings to Transifex, announce translation deadline on Transifex.
  • 10-14 days before release: Feature deadline. Bug fixes only after this time. No more features, refactoring or cleanup.
  • 3-4 days before release: Translation deadline. Pull translations from Transifex and check in.
  • 3-4 days before release: Checkin deadline. No checkins after this time without the permission of the release builder.
  • Heures qui précèdent la sortie : délai limite d’examen du code.

Monotone

  • Avoir une compréhension de base des systèmes distribués de contrôle de source, même si vous n’avez pas utilisé Monotone auparavant. Demandez de l’aide si vous en avez besoin. Une fois poussé, les checkins sont pour toujours, il n’y a pas d’annulation. Veuillez être prudent. Si vous n’avez pas utilisé Monotone auparavant, commencez pas à pas. Vérifiez quelques petits changements et voyez comment cela marche.
  • Testez vos changements avant de les envoyer. Si vous préférez le modèle de développement envoyer-avant-de-tester, utilisez votre propre branche de développement (par exemple i2p.i2p.yourname.test) et une fois que cela marche bien propagez en retour vers i2p.i2p. Ne cassez pas la build. Ne causez pas de régressions. Dans le cas où vous le feriez (cela arrive), veuillez ne pas disparaitre pendant une longue période après avoir poussé vos changements.
  • Si votre changement n’est pas insignifiant, ou que vous voulez que les gens le testent et avez besoin de bons rapports de test pour savoir si votre changement a été testé ou pas, ajoutez un commentaire de checkin dans history.txt et incrémentez la révision de build dans RouterVersion.java.
  • Assurez que vous avez le dernier fichier monotonerc dans _MTN. N’envoyez pas par dessus des révisions non éprouvées.
  • Veillez à 'mtn pull' et 'mtn update' à la dernière version avant d’envoyer et de pousser. Si par erreur c’est différent, fusionnez et poussez dès que possible. Ne faites pas régulièrement d’autres fusions pour vous. Oui, nous savons que Monotone dit de pousser puis de fusionner, mais dans l’espace de travail fusionner fonctionne aussi bien que dans une fusion en database, sans créer de révision de fusion.
  • N’envoyez pas de changements majeurs dans la branche principale i2p.i2p tardivement dans le cycle de sortie. Si un projet va vous prendre davantage que quelques jours, créez votre propre branche dans Monotone et faites le développement là afin de ne pas bloquer les sorties.

Style de codage

  • Le style de codage partout dans la plupart du code est de 4 espaces pour l’indentation. N’utilisez pas de tabulations. Ne re-formatez pas le code. Si votre IDE ou éditeur veulent tout re-formater, prenez-en le contrôle. Oui, nous savons que 4 espaces est pénible, mais peut-être que vous pouvez configurer votre éditeur convenablement. En quelques endroits, le style de codage est différent. Utilisez le bon sens. Imitez le style dans le fichier que vous modifiez.
  • Toutes les nouvelles classes et méthodes publiques ou privées des paquets requièrent Javadocs. Ajoutez @since release-number. Javadocs pour les nouvelles méthodes privées est préférable.
  • For any Javadocs added, there must not be any doclint errors or warnings. Run 'ant javadoc' with Oracle Java 14 or higher to check. All params must have @param lines, all non-void methods must have @return lines, all exceptions declared thrown must have @throws lines, and no HTML errors.
  • Les classes dans core/ (i2p.jar) et les portions d’i2ptunnel font partie de notre API officielle. Il y a plusieurs plug-ins out-of-tree et d’autres applications qui comptent sur cette API. Soyez prudent de ne pas faire quelconque changement qui casserait cette compatibilité. N’ajoutez pas de méthodes à l’API à moins qu’elles ne soient d’utilité générale. Les Javadocs pour les méthodes d’API devraient être claires et complètes. Si vous ajoutez ou changez l’API, mettez aussi à jour la documentation sur le site Web (branche i2p.www).
  • Étiquetez des chaînes pour traduction quand c’est nécessaire. Ne changez pas de chaînes étiquetées existantes à moins que ce soit vraiment nécessaire, car cela cassera les traductions existantes. N’ajoutez pas ni ne changez les chaînes étiquetées après le "gel d’étiquette" dans le cycle de sortie afin que les traducteurs aient une chance de mettre à jour avant la sortie.
  • Utilisez de classes génériques et concurrentes quand cela est possible. I2P est une application grandement multiple.
  • Etre habitué des pièges Java communs qui sont attrapés par findbugs. Exécutez 'ant findbugs' pour apprendre davantage.
  • We require Java 8 to build and run I2P as of release 0.9.47. Do not use Java 7 or 8 classes or methods in embedded subsystems: addressbook, core, i2ptunnel.jar (non-UI), mstreaming, router, routerconsole (news only), streaming. These subsystems are used by Android and embedded applications that require only Java 6. All classes must be available in Android API 14. Java 7 language features are acceptable in these subsystems if supported by the current version of the Android SDK and they compile to Java 6-compatible code.
  • Try-with-resources cannot be used in embedded subsystems as it requires java.lang.AutoCloseable in the runtime, and this is not available until Android API 19 (KitKat 4.4).
  • The java.nio.file package cannot be used in embedded subsystems as it is not available until Android API 26 (Oreo 8).
  • Other than the above limitations, Java 8 classes, methods, and constructs may be used in the following subsystems only: BOB, desktopgui, i2psnark, i2ptunnel.war (UI), jetty-i2p.jar, jsonrpc, routerconsole (except news), SAM, susidns, susimail, systray.
  • Plugin authors may require any minimum Java version via the plugin.config file.
  • Convertissez explicitement entre types primitifs et classes; ne comptez pas sur l’autoboxing/unboxing.
  • N’utilisez pas URL. Utilisez URI.
  • N’interceptez pas Exception. Interceptez RuntimeException et vérifiez les exceptions individuellement.
  • N’utilisez pas String.getBytes() sans un argument jeu de caractères UTF-8. Vous pouvez aussi utiliser DataHelper.getUTF8() ou DataHelper.getASCII().
  • Spécifiez toujours un jeu de caractères UTF-8 lors de la lecture ou de l’écriture de fichiers. Les utilitaires DataHelper peuvent être utiles.
  • Toujours spécifier un local (e.g. Locale.US) avec String.toLowerCase() ou String.toUpperCase(). N’utilisez pas String.equalsIgnoreCase() car on ne peut pas spécifier de local.
  • N’utilisez pas String.split(). Utilisez DataHelper.split().
  • Don't add code to format dates and times. Use DataHelper.formatDate() and formatTime().
  • Assurez-vous que InputStreams et OutputStreams sont fermés en blocs finaux (finally blocks).
  • Utilisez {} pour tous les blocs for et while, même pour une seule ligne. Si vous utilisez {} soit pour un bloc if, else ou if-else, faites-le pour tous les blocs. Placez "} else {" sur une seule ligne.
  • Spécifiez les champs en tant que finaux chaque fois que possible.
  • Ne pas stocker dans des champs statiques I2PAppContext, RouterContext, Log ni autres références au routeur ou aux éléments contextuels.
  • Ne commencez pas de fils (threads) dans des constructeurs (contructors). Utilisez I2PAppThread au lieu de fil.

Licences

  • Vérifiez seulement le code que vous avez écrit vous-même. Avant de vérifier n’importe quel code ou bibliothèque issu d’autres sources, justifiez pourquoi c’est nécessaire, vérifiez que la licence est compatible, et obtenez l’approbation du développeur principal.
  • Si vous obtenez vraiment l’approbation d’ajouter du code externe ou des jars, et que les fichiers binaires sont disponibles dans n’importe quelle paquet Debian ou Ubuntu, vous devez mettre en œuvre des options de construction et d’empaquetage afin d’utiliser le paquet externe à la place. Liste de contrôle des fichiers à modifier : build.properties, build.xml, debian/control, debian/i2p-router.install, debian/i2p-router.links, debian/rules, sub-build.xml
  • Pour n’importe quelles image enregistrée depuis des sources externes c’est votre responsabilité de d’abord vérifier que la licence est compatible. Incluez la licence et sourcez l’information dans le commentaire de checkin.

Bogues

  • Gérer les tickets Trac est le travail de tout le monde, veuillez aider. Surveillez dans trac.i2p2.de les tickets auxquels vous avez été assigné ou auxquels pouvez aider. Assignez, catégorisez, commentez, réparez, ou fermez des tickets si vous le pouvez.
  • Les nouveaux développeurs devraient commencer en corrigeant un bogue. Recherche des bogues dans trac avec le mot-clé 'easy'. Quand vous avez une correction, attachez votre patch au ticket et ajoutez le mot-clé 'review-needed'. Ne fermez pas le ticket avant qu’il n’ait été passé en revue et que vous avez enregistré vos changements avec succès. Une fois que vous ceci avez fait sans à-coups pour deux ou trois tickets, vous pouvez suivre la procédure normale ci-dessous.
  • Fermez un ticket quand vous pensez que vous l’avez réparé. Nous n’avons pas de département de test pour vérifier et fermer des tickets. Si vous n’êtes pas sûr vous l’avez réparé, fermez le et ajouter une note disant "Je pense que je l’ai réparé, veuillez tester et réouvrir si c’est toujours cassé". Ajoutez un commentaire avec le numéro de build dev ou la révision et mettez le jalon à la prochaine sortie.