zephyrproject-rtos/zephyr

Be more consistent with Kconfig language

Aperta

#7272 aperta il 30 apr 2018

Vedi su GitHubGuida contributor
 (1 commento) (0 reazioni) (1 assegnatario)C (9144 fork)batch import
EnhancementGood first issuearea: Configuration Systemarea: Documentation

Metriche repository

Star
 (15.249 stelle)
Metriche merge PR
 (Merge medio 4g 21h) (1000 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Analizza i prompt Kconfig inconsistenti nel repository, crea un modello standardizzato e aggiorna tutti i file Kconfig. Sviluppa linee guida per la revisione del codice per garantire la coerenza.
Tech stack
c
Dominio
build system
Tipo issue
Refactoring
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
3-5 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
50