README.md

Pivotal Agency Code Standards

We endorse code standards, to:

• Improve team-wide code quality
• Enhance each product's performance
• Reduce developer decision making fatigue
• In general, code consistency and readability across team members
• Help on-board new team members

We work with various frameworks and libraries, authored by different communities. This comes with different (and sometimes conflicting) code standards. For example, Wordpress has different code standards to Laravel. Instead of enforcing a set of code standards for a language, we support being consistent with each project's framework/library/boilerplate code standards.

---

Languages

• HTML
• CSS
• Javascript
• PHP - Laravel
• PHP - Wordpress
• PHP - Default position

---

Editor Settings

1. EditorConfig

1. Install EditorConfig to your editor, to recognize our .editorconfig file per project
2. Ensure the .editorconfig exists in the root dir of your project

2. PHP (PHPCS)

1. Setup PHPCS on your machine
2. Configure your project via a phpcs.xml in your project root
   • Wordpress Code Standards:
     • Root directory phpcs.xml
     • Theme directory phpcs.xml
   • Laravel Code Standards
3. Setup your IDE to give you realtime feedback

3. JS (eslint)

1. Setup your IDE to give you realtime feedback
2. Configure your project via a .eslintrc.js in your project root
   • Wordpress Theme .eslintrc.js
   • React .eslintrc.js