Clarify commit suggestions
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
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
- Aucun Dockerfile ni fichier Docker Compose
- Aucun modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de Imageomics/Collaborative-distributed-science-guide
-
bug
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
-
enhancement good first issue
Difficulté 1/5 Moins d'une heure Accessibilité débutants 72/100
-
enhancement good first issue
Difficulté 1/5 Moins d'une heure Accessibilité débutants 68/100
-
Add footnote hover?Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 48/100
-
Update GH PR Guide PageOuvertedocumentation enhancement
Difficulté 3/5 1-2 jours Accessibilité débutants 65/100
Toutes les issues de Imageomics/Collaborative-distributed-science-guide
Issues similaires
-
automated endpoint-dead needs-curation
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
almanac-data/climate-almanac#138 ·
Les mainteneurs répondent en général sous 1 jour
-
enhancement
Difficulté 2/5 1-3 heures Accessibilité débutants 67/100
OceanDataTools/openrvdas#760 ·
Les mainteneurs répondent en général sous 1 jour
-
level/subtask type/enhancement
Difficulté 2/5 1-3 heures Accessibilité débutants 75/100
wazuh/wazuh-virtual-machines#1091 ·
Les mainteneurs répondent en général sous 1 jour
-
Python: Bug: ChatMessageContent.from_element drops AudioContent and BinaryContent into raw TextContentPeut-être pris @halcyon-past l’a pris aujourd’hui. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 75/100
microsoft/semantic-kernel#14824 · 1 commentaire ·
Les mainteneurs répondent en général sous 3 jours
-
help wanted
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
stack314/django-neolith#142 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour