https://github.com/bleenco/styleguide
:blue_book: A Bleenco style guide and mandatory readme for every contributor.
https://github.com/bleenco/styleguide
Last synced: 6 months ago
JSON representation
:blue_book: A Bleenco style guide and mandatory readme for every contributor.
- Host: GitHub
- URL: https://github.com/bleenco/styleguide
- Owner: bleenco
- Created: 2017-04-20T10:51:50.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-06-30T14:08:26.000Z (over 5 years ago)
- Last Synced: 2025-02-16T09:15:27.448Z (8 months ago)
- Size: 17.6 KB
- Stars: 5
- Watchers: 4
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Bleenco Styleguide For Developers
Note: This styleguide is not an exhaustive list of rules and processes. It is rather an emerging repository of habits that have proven to be something called "good software engineering practices". This repository can be modified at any time without any prior notification, if you want to stay on top of it please hit the star and follow updates.
The aim of this styleguide is to:
* inform guests on processes within Bleenco development team,
* brief new candidates and encourage them to submit their first pull request,
* remind current contributors what quality standard do we stand for.
## Table of Contents
- [Committing](COMMITTING.md)
- [Submitting](SUBMITTING.md)
- [Code of Conduct](https://github.com/bleenco/code-of-conduct/blob/master/CODE_OF_CONDUCT.md)
## Coding Rules
To ensure consistency throughout the source code, keep these rules in mind as you are working:
* All features or bug fixes **must be tested** by one or more specs (unit-tests, API tests).
* All public API methods **must be documented**.
* Abstruse **build must be green**