Code Style
This document describes the coding style of ShakaCode. Yes, it's opinionated, as all style guidelines should be. We shall put as little as possible into this guide and instead rely on:
- Use of linters with our standard linter configuration.
- References to existing style guidelines that support the linter configuration.
Client Side JavaScript and React
- See the Shakacode JavaScript Style Guide
Style Guides to Follow
Follow these style guidelines per the linter configuration. Basically, lint your code and if you have questions about the suggested fixes, look here:
Ruby Coding Standards
JavaScript Coding Standards
- ShakaCode Javascript
- Use the eslint-config-shakacode NPM package with ESLint.
- JSDoc
Git coding Standards
Sass Coding Standards
Git Usage
- Follow a GitHub flow model where you branch off master for features.
- Before merging a branch to master, rebase it on top of master, by using command like
git fetch; git checkout my-branch; git rebase -i origin/master. Clean up your commit message at this point. Be super careful to communicate with anybody else working on this branch and do not do this when others have uncommitted changes. Ideally, your merge of your feature back to master should be one nice commit. - Run hosted CI and code coverage.