reactjs / reactjs/react.dev

Capitalize React concepts in docs

Đang mở
#6,713 29 bình luận 1 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

good first issue type: documentation
Ngôn ngữ chính
JavaScript
Star
11.8k
Fork
7.9k
Merge trung bình
1 ngày 11 giờ
Pull request đã merge (30 ngày)
11

Mô tả

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"

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Bắt đầu với style guide của issue, sau đó tìm kiếm trong tất cả các trang tài liệu một khái niệm còn lại như Actions hoặc Suspense, loại trừ các trang blog và cộng đồng. Xem xét từng cách sử dụng trong ngữ cảnh, vì các thuật ngữ lập trình chung và các tiêu đề như {/* usestate */} vẫn được viết thường. Hoàn tất có nghĩa là một PR bao quát tất cả cách sử dụng của khái niệm đó với cách viết hoa được chỉ định.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
javascript, react
Lĩnh vực
content, documentation
Loại issue
Tài liệu
Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
35/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.