Soumission de code efficace: meilleures pratiques pour éviter les problèmes futurs

La soumission du code du mauvais code peut causer de grands problèmes. Avez-vous déjà eu du mal à poursuivre l'intention d'un changement spécifique ou de l'état du code actuel? La bonne fa?on de soumettre du code peut éviter efficacement ces difficultés. Cet article plongera dans les meilleures pratiques de la soumission des logiciels.

Points de base

• La soumission du code correct peut empêcher la confusion et gagner du temps à venir. Les soumissions doivent être atomiques, en ne traitant qu'un seul problème spécifique à la fois, plut?t que d'affecter gonflé un grand nombre de fichiers et d'ajouter plusieurs fonctionnalités.
• Les bonnes soumissions devraient être claires, perspicaces et atomiques. La structure de validation doit contenir des types ou des composants, des sujets clairs et du texte corporel facultatif pour fournir plus de contexte ou de détails.
• Le problème doit être traité dans les informations de soumission, en utilisant le mot-clé et le numéro d'identification de la question. Cela facilite le suivi des taches, des améliorations et des erreurs dans le projet.
• Quelle que soit la taille de l'équipe, la soumission correcte du code est cruciale pour une bonne gestion de projet. Il maintient l'intégrité de la base de code et facilite la compréhension et le traitement du code.

Pourquoi s'embêter?

Si vous avez déjà stocké votre projet sur GitHub, vous pourriez penser que le fichier est s?r et vous pouvez extraire les modifications chaque fois que vous avez besoin de mettre à jour votre code, ce qui est suffisant. Tout cela peut être vrai. Mais voyons quels problèmes potentiels peuvent être évités en faisant plus d'efforts et quels avantages supplémentaires vous obtiendrez si vous faites cela.

Le travail unique doit être évité dans le travail d'équipe ou le travail personnel

Les raisons ci-dessus proviennent généralement des développeurs habitués à travailler seuls. Mais quand ils ont besoin de partager du code avec les autres, les choses deviennent désordonnées et nécessitent beaucoup d'explications. N'oubliez pas que notre travail est plus que d'écrire du code. Nous devons également gérer des choses, ce qui nécessite un certain degré d'organisation et de méthodologie. Bien que le travail d'équipe soit plus susceptible d'exposer les problèmes causés par une mauvaise organisation, nous pouvons également bénéficier de meilleures approches, même lorsque nous travaillons seuls.

Soumission atomique et soumission gonflée

Nous devons tous annuler un petit changement, seulement pour nous retrouver à la rechercher dans un énorme engagement qui a changé des dizaines de fichiers et ajouté plusieurs fonctionnalités. Si le changement est dans un seul engagement qui ne gère que ce problème particulier, le retour en arrière sera beaucoup plus facile.

Way encombré, gonflé

Dans cet exemple, nous pouvons être s?rs que de nombreux fichiers sont affectés. De plus, les informations "nouvelles composants" ne nous indiquent pas beaucoup d'informations - telles que les composants, qui fonctionnent de ces composants, et si les fonctions sont nouvelles ou refactorisées. De plus, des erreurs existantes sont-elles résolues?

<code>git add *
git commit -m "new components"</code>

Ces informations seront très importantes lorsque nous devons changer ou restaurer quelque chose. Nous essaierons de trouver une épingle dans une pile de foin, et nous pourrions finir par regarder la base de code et passer un temps précieux à déboguer.

VOYAGE ATOMIQUE

<code>git add *
git commit -m "new components"</code>

Maintenant, nous commen?ons à avoir une meilleure idée de ce qui est arrivé au que engage.

L'astuce est que nous pouvons commettre des changements semi-automatiquement dans le cadre du flux de travail. Autrement dit, effectuez un Block de travail qui effectue des opérations très spécifiques (implémenter des fonctions spécifiques, corriger les erreurs, optimiser les algorithmes), effectuer des tests (écrire des tests unitaires si nécessaire), ajouter des descriptions lorsque la mémoire est fra?che, puis soumettre maintenant. Répéter ce processus.

bonne structure de soumission

Ces règles ne sont pas réglées dans la pierre, mais elles peuvent vous aider à évaluer à quoi pourrait ressembler une bonne soumission:

Clairosité: il n'y a aucun doute sur le travail effectué pour soumettre des modifications.
perspicace: décrivez clairement la fonctionnalité du code, fournissez des liens ou des informations supplémentaires si nécessaire, et marquez les erreurs ou problèmes traités.
ATomicité: ne traitez qu'une seule chose à la fois (considérez un "bloc de travail", qui peut durer de 20 minutes à 2 heures, voire 2 minutes s'il s'agit d'une correction rapide de bogues).

Regardons un modèle et décomposons-le:

<code>git add ui/login.html static/js/front-end.js
git commit -m "validate input fields for login"</code>

Type, composant ou sous-système

Ce sera un ensemble de fonctionnalités de projet logiciel qui peuvent être combinées ensemble. Par exemple, les types soi-disant dans AngularJS, ou le soi-disant sous-système de SrummVM.

(obligatoire) Topic

Le sujet est une description simple et simple du travail effectué par la soumission afin que tout le monde puisse le voir en un coup d'?il.

En termes de format de sujet, je suis généralement les directives simples suivantes:

Utiliser des phrases impératives ("changer" au lieu de "changé")
Ne capitalisez pas la première lettre
N'ajoutez pas de périodes à la fin (.)
Ajouter "(…)" S'il y a un corps facultatif

(facultatif) Texte

Parfois, nous devons fournir plus de détails que pour la ligne d'objet pour fournir un contexte, par exemple lors de la correction des bogues persistants, ou lors de la fissuration des algorithmes.

Dans ces cas, vous pouvez simplement entrer un caractère double nouveau (afin que le sujet soit utilisé comme titre), puis saisir les informations requises.

N'oubliez pas de faire face au problème!

Enfin, il y a un autre problème pour résoudre le problème (jeu de mots!). Tout projet de développement logiciel de grand et moyen décent devrait utiliser des trackers de problèmes pour suivre les taches, les améliorations et les erreurs - qu'il s'agisse d'Atlassian Jira, de Bugzilla, de trackers de problèmes de Github ou autre.

Gestion des problèmes

Si vous ne le savez pas, la plupart des systèmes peuvent gérer les problèmes directement à partir des informations de soumission!

vous pouvez:

fermer / résoudre le problème

Si le problème a été fermé avant, rouvrez le problème
Si la fonction est reportée à une date ultérieure, alors la question de la rétention
• Utilisez simplement ces mots clés et le numéro d'identification de la question.

De plus, vous pouvez toujours citer la question comme un moyen de fournir un contexte, même si vous ne souhaitez pas modifier son état - par exemple, "voir # 12".

Toutes ces références seront visibles pour quiconque ouvre le problème sur le tracker, ce qui facilite le suivi de la progression d'une tache ou d'une erreur donnée.

Résumé

vous ne le ferai pas toujours correctement (pas moi-même!). Les choses peuvent devenir désordonnées, et parfois vous ne suivez pas les règles que vous définissez pour vous-même ou votre équipe - cela fait partie du processus. Mais j'espère que vous savez qu'en faisant simplement des mises à niveau de votre flux de travail, vous pouvez être organisé et gagner du temps pour vous et votre équipe à long terme.

J'ai également appris de l'expérience que le projet implique dix développeurs et est toujours entièrement géré par vous, ce qui le rend presque impossible. En bref, la soumission des changements de code de la bonne manière - il s'agit d'un élément clé de la bonne gestion de projet.

lecture complémentaire

• raconter des histoires avec l'histoire de Git. Un article intéressant de Seb Jabocs sur FutureLearn.
• Guide d'information de soumission d'Angular. Même si vous n'utilisez pas Angular, c'est une lecture utile.
• FreeBSD Soumider Guide. S'il y en a un, voici un guide approfondi sur le sujet.
• Comment organiser correctement les fichiers dans votre base de code et éviter la confusion. Nous expliquons comment organiser des documents pour les grands et petits projets, offrant des meilleures pratiques faciles à suivre.
• start rapide git. Ce guide concis est con?u pour aider les débutants à ma?triser rapidement Git en un week-end.
• Git professionnel. Le livre de Wiley va plus loin, offrant aux développeurs des recherches approfondies dont ils ont besoin pour devenir Git Masters.

FAQS (FAQ)

• Quelle est la différence entre une base de code et un code source?

La base de code fait référence à l'ensemble de la collection de code source utilisé pour créer un logiciel ou une application spécifique. Il comprend toutes les versions du code et des branches. D'un autre c?té, le code source fait partie de la base de code actuellement en cours de traitement. Il est du code écrit dans un langage de programmation puis compilé dans un programme exécutable.

• Comment fonctionne les changements de validation dans la base de code?

La soumission des modifications dans la base de code implique de modifier le code source, puis d'enregistrer ces modifications à la base de code. Ce processus se fait généralement dans un système de contr?le de version comme Git. Lorsque vous soumettez vos modifications, vous prenez réellement un instantané de votre travail à ce moment-là. Cela vous permet de suivre les modifications que vous avez apportées et de restaurer en versions précédentes si nécessaire.

• Quelle est l'importance de soumettre des changements de la bonne manière?

commettre des changements de la bonne manière est essentiel pour maintenir l'intégrité de la base de code. Il garantit que la base de code est maintenue propre et facile à gérer, ce qui permet à d'autres développeurs de comprendre et de traiter le code. Il aide également à suivre les changements et à identifier quand et où les erreurs sont introduites dans le code.

• Quelles sont les meilleures pratiques pour soumettre des modifications?

Certaines meilleures pratiques pour soumettre des modifications incluent la fabrication de petits validations incrémentielles, la rédaction d'informations claires et descriptives et testent vos modifications avant de soumettre. Il est également important de synchroniser régulièrement votre base de code locale avec la base de code principale pour éviter les conflits.

• Qu'est-ce qu'un système de contr?le de version et qu'est-ce qu'il a à voir avec la base de code?

Le système de contr?le de version est un outil qui aide à gérer les modifications de base de code. Il suit chaque modification du code dans un type spécial de base de données. Si une erreur se produit, les développeurs peuvent rembobiner le temps et comparer les versions antérieures du code pour aider à corriger l'erreur tout en minimisant l'impact sur tous les membres de l'équipe.

• Comment éviter les conflits lors de la soumission des modifications?

Les affrontements peuvent être évités en synchronisant régulièrement votre base de code locale avec la base de code principale. Cela garantit que vous travaillez toujours sur la dernière version de votre code. Il est également important de communiquer avec votre équipe, en s'assurant que tout le monde est conscient des modifications apportées.

• Quel est le r?le des bases de code dans le développement de logiciels?

La bibliothèque de code joue un r?le crucial dans le développement de logiciels. Il agit comme un référentiel central pour tout le code source, permettant aux développeurs de travailler ensemble et de gérer différentes parties du logiciel en même temps. Il aide également à suivre les changements et à maintenir l'historique des projets.

• Quelle est la différence entre une base de code et un référentiel de code?

La bibliothèque de code fait référence à toute la collection du code source du logiciel, et le référentiel de code est l'endroit où ce code est stocké et géré. Un référentiel de code peut contenir plusieurs référentiels de code, généralement gérés par un système de contr?le de version.

• Comment s'assurer que ma soumission est significative et utile?

Pour vous assurer que vos commits sont significatifs et utiles, il est important de faire de petits validations incrémentielles, chaque engagement a son propre objectif spécifique. Chaque engagement doit représenter un seul changement logique. Il est également important d'écrire des soumissions claires et descriptives qui expliquent les modifications apportées et pourquoi.

• Quelle est la relation entre la base de code et la construction?

Le batiment est le processus de conversion du code source à partir d'une base de code en programmes exécutables. La base de code est l'entrée du processus de construction, et la sortie est un produit logiciel qui peut être installé et exécuté sur l'ordinateur. Le processus de build peut inclure la compilation de code, la liaison des bibliothèques et les logiciels d'emballage pour la distribution.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!