/Frontend-Rules

Rules for Frontend Development at Architect

MIT LicenseMIT

Front End Rules

The Rules

We have a growing Front End team here at Architect working on different projects all over the place all the time, in collaboration and in solitude. Yet we should all be able to pick up and work on any project at any time, regardless of the initial developer and be able to find our way around, understand what we're looking at and pick up where someone left off as easily if it were our own project to begin with.

The rules are here as our guide to all things Front End at Architect, they are created by us and for us*. By following these rules we ensure our code is well-written, well thought out, and easy to maintain.

Rule 1: Obey the rules.

Where possible all of these rules should be followed to the letter. But, all rules are open to discussion and review. Obviously there are also times where a rule must be broken, but you should be able to explain why it was necessary and what benefit it gave you.

Rule 2: Lead by example.

Your code should follow the rules and you should help others follow the rules when you can. Code reviews and pair programming are encouraged. Do your best to make yourself available for code review's when possible and ask for code reviews when there's time on your project.

Rule 3: It's all about the bike code.

None of these rules are personal, there is no agenda in the rules; it's all about the code. The rules are here to help us write good code and work together as a team. It's about learning as well, front end development is continually evolving with new techniques and new tools becoming available all the time, the rules will keep evolving with these best practices and be updated over time.

Rule 4: Contribute.

The rules are not here to be written by one and followed by all, they are written by the team for the team. So contribute your ideas and best practices! See How to Contribute.

Rule 5: Do not use that which is unnecessary.

Code and Page bloat are easily avoidable, and serve both the developer and the audience to avoid. The more external frameworks we include in our JavaScript the longer each page takes to load, and the more code we have to trawl through when something goes wrong. Usually, there is a micro-library that will do the same thing, if VanillaJS won't.