dppereyra/style-guide

Style guide for Juwai

Style Guide

This Style–guide helps Juwai team members from all departments and locations to collaborate with each other.

Languages

We are following these conventions for programmatic languages in our technical stack.

• CSS
• HTML
• JavaScript
• PHP
• Python

Workflow

We are following these processes for our daily work.

• Writing a commit message
• Writing Documentation
• Creating a Defect
• Creating a User Story
• Issues priority

Tools

Before starting anything, you might want to setup a few tools that will help you get started on the right foot. They ensure you’re notified if some code does not match these style–guides. You might want to install the respective plugin for your editor, configuration files in the repository should do the rest.

• EditorConfig helps developers define and maintain consistent coding styles between different editors and IDEs.
• phplint for PHP.
• htmllint for HTML.
• csslint for CSS.
• jshint for JavaScript.
• pep8 for Python.