zephyrproject-rtos/zephyr

Be more consistent with Kconfig language

Ouverte

#7 272 ouverte le 30 avr. 2018

Voir sur GitHubGuide contributeur
 (1 commentaire) (0 réaction) (1 personne assignée)C (9 144 forks)batch import
EnhancementGood first issuearea: Configuration Systemarea: Documentation

Métriques du dépôt

Stars
 (15 249 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

The language used in Kconfig prompts is inconsistent. This presents application developers a messy and potentially confusing user interface (when the variation in language actually intends to communicate a variation).

Examples of phrasing used to communicate that a driver should be enabled in "Device Drivers":

Device Drivers:
  <driver>
  <driver> driver
  <driver> drivers
  <driver> Drivers
  <driver> drivers options
  <driver> support
  <driver> Support
  <driver> Configuration
  <driver> Device Drivers
  Enable <driver> driver
  add support for <driver> Drivers

Definition of Done:

  • Port the Kconfig language used to be more consistent.
  • Develop guidelines that can be used in code-review (and during porting) to enforce consistency.

Guide contributeur

Direction de recherche
Analysez les invites Kconfig incohérentes dans le dépôt, créez un modèle standardisé et mettez à jour tous les fichiers Kconfig. Élaborez des directives de révision de code pour garantir la cohérence.
Stack technique
c
Domaine
build system
Type d'issue
Refactorisation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
3-5 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
50