This repo contains The Frontend Playbook. It details how we run software development and how we make web and mobile products together. It's filled with things we've learned based on our own experience and study of others' experiences.
The main motivator for this playbook is not to document a list of guidelines, but rather to create an opportunity to collaborate on them, and to gain consensus.
This is a living document that we contribute to in a public GitHub repo. Reasons for doing this in the open include (but are not limited to):
-
Interacting with and learning from others. Receiving contributions from people who don't work here can help us, providing learning opportunities that we would not receive otherwise - for example, see this contribution from @rowanmanning.
-
Providing a showcase for our work/ethics. This is really useful when hiring people (for both parties). We've had very positive feedback from interviewees - it's a great recruiting tool. It also means that people are quickly up and running when they join.
See "Changing the laws of engineering with pull requests" for an in depth explanation of how developing a playbook like this is of benefit.
There's no particular order to which you should read the playbook, but the Practices section is probably a good starting point.
To contribute please clone the repo (or fork it if you're an external contributor), create a new branch for your changes, then create a pull request to merge your changes in.
Please keep discussion inside the issues and pull requests, avoiding Slack, hallway conversations etc. Remember that this repo is public, and the discussions we have can be of benefit to people apart from us.
Read the full contributor guide.
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP (Best Current Practice) 14 (RFC 2119, RFC8174) when, and only when, they appear in all capitals, as shown here.
The Frontend Playbook is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.
You should have received a copy of the license along with this work. If not, see Creative Commons BY-NC-SA 4.0 license.