This repository is dedicated to documenting, sharing, and evolving the best practices for frontend engineering. My goal is to foster a culture of excellence, collaboration, and continuous improvement among frontend engineers. Here, you will find guidelines, principles, and actionable advice to help engineers:
- Design features thoughtfully and collaboratively.
- Write clean, maintainable, and well-tested code.
- Embrace code reviews and feedback as opportunities for growth.
- Break down work into manageable, high-quality deliverables.
- Continuously learn and contribute to the team's collective knowledge.
- Uphold high standards for code quality, security, and team participation.
Explore the Code Quality folder for detailed practices, including our Manifesto, and join me in striving for frontend engineering excellence.
Clear, concise, and well-structured documentation is essential for effective engineering teams. To help you write better documentation, I recommend following the principles outlined in Documentation done right: A developer’s guide:
- Know your audience: Tailor your documentation to the needs and experience level of your readers.
- Be clear and concise: Use simple language and avoid unnecessary jargon.
- Structure matters: Organize content logically with headings, lists, and examples.
- Keep it up to date: Regularly review and update documentation as code and processes evolve.
- Use examples and visuals: Illustrate concepts with code snippets, diagrams, or screenshots where helpful.
- Encourage contributions: Make it easy for others to suggest improvements or corrections.
For more tips and best practices, read the full blog post: Documentation done right: A developer’s guide.