reactjs / reactjs/react.dev

Capitalize React concepts in docs

Aperta
#6,713 29 commenti 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

good first issue type: documentation
Lingua principale
JavaScript
Stelle
11.8k
Fork
7.9k
Merge medio
1g 11h
PR unite (30g)
11

Descrizione

Summary

We should be capitalizing proper React concepts in the docs. This was flagged by @samselikoff here and I took a first pass at correct Effects, Hooks, and Transitions in https://github.com/reactjs/react.dev/pull/6712.

Remaining items

The remaining items are:

Submitting a PR

  • Please do not ask to take an item, just submit a PR. If multiple people submit the same PR, I'll add co-author credit to the commit.

  • Only submit one PR per concept

  • When you submit a PR, please try and cover all usages in all the docs, on all pages excluding the blog and community pages.

  • Avoid fixing one or two instances and favor full coverage to minimize the number of PRs and reviews.

Note that headings like {/* usestate */} must stay lower case, so a find and replace won't work.

Style Guide

  • Capitalize React-specific concepts: Capitalize the names of React concepts and features when referring to them specifically.
  • Lowercase all others: Use lowercase when these words are used in a general context or referring to their general computing or programming meaning.
Guidelines for Specific Terms

Components

  • Capitalize when referring to React Components
    • ❌ Incorrect: "functional components are a core concept in React."
    • ✅ Correct: "Functional Components are a core concept in React."
  • Use lowercase when discussing components in a general programming or descriptive sense
    • ❌ Incorrect: "Components should manage their own State."
    • ✅ Correct: "components should manage their own state."

State

  • Capitalize when discussing React State in the context of the React system
    • ❌ Incorrect: "Create dynamic and interactive Components with state."
    • ✅ Correct: "Create dynamic and interactive Components with State."
  • Use lowercase for the general concept of state
    • ❌ Incorrect: "When a component's State changes, it re-renders."
    • ✅ Correct: "When a component's state changes, it re-renders."

Effects

  • Capitalize when referring to Effects used via hooks like useEffect
    • ❌ Incorrect: "Use effects to perform side effects in function components."
    • ✅ Correct: "Use Effects to perform side effects in function components."
  • Use lowercase for general references to effects or side effects in programming
    • ❌ Incorrect: "Effects let you perform side Effects in function components."
    • ✅ Correct: "Effects let you perform side effects in Function Components."

Transitions

  • Capitalize when discussing the specific Transition feature ("use Transitions to defer updates").
    • ❌ Incorrect: "use transitions to defer updates"
    • ✅ Correct: "use Transitions to defer updates"
  • Use lowercase when referring to the general concept of transitions in UI/UX ("transition animations").
    • ❌ Incorrect: You can also add a CSS Transition to delay dimming
    • ✅ Correct: You can also add a CSS transition to delay dimming

Context

  • Capitalize when discussing the specific Context feature ("use Context to share data").
    • ❌ Incorrect: "use context to share data between components"
    • ✅ Correct: "use Context to share data between Components"
  • Use lowercase when the word "context" refers to the general concept of context (understand the context)
    • ❌ Incorrect: "understand the Context it's running in"
    • ✅ Correct: "understand the context it's running in"

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia dalla guida di stile dell'issue, quindi cerca in tutte le pagine della documentazione un concetto rimanente, come Actions o Suspense, escludendo le pagine del blog e della community. Esamina ogni utilizzo nel contesto, perché i termini generali di programmazione e le intestazioni come {/* usestate */} rimangono in minuscolo. Il lavoro è completato quando un PR copre tutti gli utilizzi di quel concetto con la capitalizzazione specificata.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
javascript, react
Ambito
content, documentation
Tipo di issue
Documentazione
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.