An open API service indexing awesome lists of open source software.

https://github.com/vicainelli/styleguide


https://github.com/vicainelli/styleguide

guide guidebook style-guide styled-components styleguide

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README

          

## styleguide

> Guides for shipping great code.

## Goal

> It’s harder to read code than to write it. - Joel Spolsky

The goal of this repository is to document the standards we use to write and publish code at [menuqr](http://menuqr.com.br).

By following a common approach we ensure that the code will not have multiple identities, but a single one. This helps us maintain what we work on, onboard new people and focus on providing value.

All the standards proposed here are based on our own experience writing code and the many conversations we have in our weekly meetings. There's no such thing as right or wrong, only what works better for us and improves our workflow.

## Topics

* [Best practices](/best-practices/README.md)
* [SCM](scm/README.md)
* [Code Review](code-review/README.md)
* [JavaScript](/javascript/README.md)
* [CSS](css/README.md)
* [Markup](markup/README.md)

## Contributing

If you have something you want to add, remove or improve, feel free to [open an issue](https://github.com/menuqr/styleguide/issues/new) and ping the team.

## Credits

Created and maintened by [a whole bunch of great people](https://github.com/menuqr/styleguide/graphs/contributors).

![menuqr](./menuqr.png)

## License

[![CC0](http://mirrors.creativecommons.org/presskit/buttons/88x31/svg/cc-zero.svg)](http://creativecommons.org/publicdomain/zero/1.0)