IntelliTect / IntelliTect/CodingGuidelines
Include keyword definitions
Ouverte
documentation
- Langage dominant
- C#
- Étoiles
- 12
- Forks
- 16
- Merge moyen
- 2 min
- PR mergées (30 j)
- 7
Description
Currently our guidelines use several keywords: DO, CONSIDER, AVOID, DO NOT. However, the definitions for these require outside searching.
We should include a glossary that has the definitions for each of these.
Guide de contribution
Ouvrir le guide de contribution
Piste de recherche
Start by locating the documentation page or section containing the DO, CONSIDER, AVOID, and DO NOT keywords. Add a glossary defining those four terms, then review the rendered guidelines to confirm the definitions are easy to find and understand.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 1/5
- Temps estimé
- 1-3 heures
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 45/100