Clarify commit suggestions

Ouverte
#39 3 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
2/5
Temps estimé
Une demi-journée
Accessibilité débutants
45/100
Type d'issue
Documentation
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
git
Domaine
documentation

Piste de recherche

Commencez par la section liée « Formatting and Naming Conventions » du Collaborative Distributed Science Guide et examinez ses recommandations actuelles concernant les commits. La tâche est considérée comme terminée lorsque la section explique clairement l’objectif des messages de commit, la lisibilité et la compréhension du travail effectué, fournit des liens vers de bonnes pratiques de commits lisibles par machine et souligne pourquoi les changements sont effectués.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

design documentation help wanted question

The Formatting and Naming Conventions section could use a re-visit. I think we need to elevate the commit portion, but also make it more in-line with practice. We should summarize the purpose of commit messages, highlighting important aspects of readability and understanding processes done. Then also link to good practices for, e.g., machine-readability and such, but the ultimate goal of understandable commits (why is this change happening) needs to be expressed clearly.

Langage dominant
Python
Étoiles
1
Forks
1
Merge moyen
6 j 1 h
PR mergées (30 j)
1

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de Imageomics/Collaborative-distributed-science-guide

Toutes les issues de Imageomics/Collaborative-distributed-science-guide

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.