Skip to content
This repository has been archived by the owner on Sep 15, 2020. It is now read-only.

Code Style Policy

Jump to bottom
Sergey Ukustov edited this page Feb 27, 2018 · 1 revision

Code

  1. TypeScript code should follow Standard guidelines. That is enforced by tslint-config-standard TSLint rules package.
  2. No debug comments should be left in code.
  3. React is for UI. Heavy logic belongs to services, decorators, domain objects, and what not.

Pull requests and Branches

  1. Branch name should follow theme/name pattern. Theme is tech if it is pure technical/engineering issue, or feature if it could be of concern to user.
  2. Branch name should capture intent of the code change. Like, "feature/add-throtling-backend", or "tech/add-test-for-shared-state".
  3. Pull request name should reflect intent of the code change. It is good if after few days the name in git history tells something to you.
  4. Pull request description should contain GitHub automation command that closes the covered issue, like "Fix #1".
Clone this wiki locally