23.6K ·GitHub
What is this?
An opinionated style guide for Angular: documented conventions for syntax, structure, and building Angular applications, written by John Papa for development teams.
An opinionated style guide for Angular: documented conventions for syntax, structure, and building Angular applications, written by John Papa for development teams.Is this a tool I add to my project, or a guide I read?Something you read, not software: the repository itself is the guide, a set of explained conventions with examples. There is nothing to install or add to your project.
Something you read, not software: the repository itself is the guide, a set of explained conventions with examples. There is nothing to install or add to your project.Is this the official Angular style guide?No — it is John Papa's personal, opinionated take, not official rules. The Angular Team did endorse it though: Igor Minar, the team lead, reviewed it and contributed feedback.
No — it is John Papa's personal, opinionated take, not official rules. The Angular Team did endorse it though: Igor Minar, the team lead, reviewed it and contributed feedback.Is it aimed at solo developers or whole teams?Primarily teams that want consistency across their Angular code, though any Angular developer can follow it. The practices come from real team work, presentations and Pluralsight training courses.
Primarily teams that want consistency across their Angular code, though any Angular developer can follow it. The practices come from real team work, presentations and Pluralsight training courses.Can I copy it as a base for my team's own conventions?Yes — it is MIT licensed, and the README's own TL;DR is: 'Use this guide. Attributions are appreciated.'
Yes — it is MIT licensed, and the README's own TL;DR is: 'Use this guide. Attributions are appreciated.'Which versions of Angular does the guide cover?Both generations: the repo holds a separate Angular 1 style guide and an Angular 2 style guide, and it tells you to choose the one that matches your app.
Both generations: the repo holds a separate Angular 1 style guide and an Angular 2 style guide, and it tells you to choose the one that matches your app.What does 'opinionated' mean here?It takes sides: instead of listing every possible approach, it shows the conventions John Papa actually uses and, more importantly, explains why he chose each one.
It takes sides: instead of listing every possible approach, it shows the conventions John Papa actually uses and, more importantly, explains why he chose each one.Is there a course that goes with it?Yes — the README points to John Papa's 'Angular Patterns: Clean Code' course on Pluralsight as a companion to the guide.
Yes — the README points to John Papa's 'Angular Patterns: Clean Code' course on Pluralsight as a companion to the guide.Where did these conventions come from?From the author's hands-on Angular work: presentations, Pluralsight training courses, and many pair programming sessions with Ward Bell, whom the README credits as a key influence on the guides.
From the author's hands-on Angular work: presentations, Pluralsight training courses, and many pair programming sessions with Ward Bell, whom the README credits as a key influence on the guides.What are similar projects?idiomatic.js, awesome-guidelines, awesome-angular, laravel-best-practices, api-guidelines, guide, CppCoreGuidelines, naming-cheatsheet
idiomatic.js, awesome-guidelines, awesome-angular, laravel-best-practices, api-guidelines, guide, CppCoreGuidelines, naming-cheatsheetWhich topics is it in?style-guide, angular, code-quality, architecture, best-practices, reference, guide, learning-resources, documentation, learning, web-development, resources
style-guide, angular, code-quality, architecture, best-practices, reference, guide, learning-resources, documentation, learning, web-development, resources