Standards Starter is intended to function as a boilerplate repository to help your company/organization quickly implement standards used by your entire team.
The standards and document structure presented here were adapted from the Human Made Engineering Handbook. As such, this project is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.
Have a good idea? Find one of my (I assume many) typos? Great! Create an issue or fork this repo and send a pull request.
It's important to note that while the default standards are mostly concerned with PHP, JavaScript, and HTML/CSS, the goal of this project is to be flexible enough to fit any project type or technology stack.
To that end, you'll notice that certain sections (Ex: File Structure) only contain placeholder documents. These documents should be written to fit your company or organization's own practices.
Fork this repository and modify it to fit your own needs.
To ensure everyone’s able to work effectively and efficiently, we enforce a number of standards across our code. Some of these are for performance and security in high-traffic, high-impact sites, while some enable us to collaborate more effectively.
While projects can deviate from these standards (and we encourage experimenting with new standards), projects tend to follow the majority of these rules and guidelines.
How to structure projects at the file level.
Code should be commented thoroughly, and here’s how to do it.
Guidelines on (meeting) privacy requirements.
Considerations on algorithmic complexity and performance.
How and when to utilize best practices.
Frontend-specific standards.
Backend-specific standards.
Various style guides for the different technologies we use.