The KXB Frontiers Guidelines project aims to help you and your team put together front-end development guidelines for your project. We hope that your guidelines will help you write more consistent, cohesive code more efficiently, produce a better quality front-end, and that they'll make it easier for new (or returning!) developers to get started in your codebase.
Props to Brad Frost, who wrote a Frontend Guidelines Questionnaire that inspired this project. 🙏
This repository includes three kinds of markdown files: this README (hello there! 👋); a template you can use to get started; and example guidelines used for real, living, breathing applications. You'll find the example guidelines in the examples folder.
We suggest you start by adding the guidelines template to your project's repository and naming it CONTRIBUTING.md. Making the guidelines a part of your codebase will make changes to them more visible to your teammates and it'll make the guidelines easy to update.
Get a pot of coffee, some decent snacks, and go through the template along with everyone on your team who might touch the front-end of your application. Although it's probably a good idea for one developer to take ownership of ensuring the guidelines get written, the process of drafting them together with your teammates is valuable in and of itself. Although they can be refined by individual authors, the document should not be written entirely by one person in isolation.
To help you get started, you can have a look at our examples and see what choices teams made when creating their CONTRIBUTING.md files.
Has your team benefitted from defining some frontend guidelines? Others might appreciate having a look at what you put together! Please open a pull request if you have a CONTRIBUTING.md file that might serve as a good example for others. You can also open a PR or get in touch with us if you'd like to contribute to the template itself.
If you used a custom config file for e.g. your linter or code formatter, feel free to include it in your example's folder. You can also include any notes you think would be helpful regarding what worked well with the guidelines and what you would have done differently.
We're thankful for any suggestions you can offer as to how we can improve on these guidelines or make it easier for others to contribute! Please share your thoughts with maja@jaakson.ca or chrisgrimsgaard@gmail.com -- we're looking forward to hearing from you 😁