Skip to content

docs: Update README #220

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,24 @@

# Frontend Fundamentals

> Guidelines for easily modifiable frontend code
> Essential principles for frontend development

**Frontend Fundamentals (FF)** is a growing collection of essential principles for building reliable, maintainable, and accessible frontend applications. It helps you answer common but tricky questions like how to judge code quality, why bundling behaves differently in dev vs. production, how screen readers interpret your UI, and how to debug efficiently.

**Frontend Fundamentals (FF)** provides standards for writing great frontend code. Think of it as a compass to help you navigate towards better code quality as a frontend developer.
It introduces four core principles of good code, along with practical examples and solutions.
https://frontend-fundamentals.com/en/

## When to Use
## 🧭 When to Use

- 🦨 When you're unsure about your code but find it hard to explain the issues logically
- πŸ‘€ When you want to learn how to quickly identify and fix bad code
- πŸ€“ When you find yourself exploring a shared link during a code review and realize, "This is exactly what my code looks like," from an objective perspective
- πŸ‘₯ When your team wants to establish a shared coding style and standards for code quality
- 🧯 When you're trying to debug a persistent frontend bug and want to double-check your fundamentals
- πŸ‘₯ When you're reviewing UI code for accessibility and want concrete do's and don'ts
- πŸ› οΈ When your team is setting shared standards for clean, robust frontend code

## πŸ“š Collections

- [Code Quality Fundamentals](https://frontend-fundamentals.com/code-quality/)
- [Bundling Fundamentals](https://frontend-fundamentals.com/bundling/)
- A11y Fundamentals (coming soon!)

## Contributing

Expand Down