StyleGuide - Aman-Codes/fossology GitHub Wiki

Code style and conventions

We are following the Airbnb JavaScript Style Guide for this project.

ESlint (a pluggable and configurable linter tool) and Prettier (an opinionated code formatter) are used to enforce the style guide.

Before making any pull request one should:

  • Run yarn fix:all to fix all auto fixable errors and warnings

  • Run yarn test to run all react test

  • Ensure that your commit contains a Signed-off-by line, also known as the Developer Certificate of Origin (DCO)

  • Ensure that you have added your name and email in the license headers of all the files that you have modified.

General Naming Convention

In the code and documentation prefer non-offensive terminology, for example:

  • allowlist / denylist (instead of whitelist / blacklist)
  • primary / replica (instead of master / slave)
  • openbox / closedbox (instead of whitebox / blackbox)