Skip to content

Coding rules

Jump to bottom
Yi Xie edited this page Oct 4, 2020 · 5 revisions

Coding Rules

Dataprep follows angular commit naming style:

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).
  • All public API methods must be documented.
  • Do not delete the code of others. If it is necessary, make a comment to illustrate the reason.
  • One pull request for only one functionality. If the functionality depends on the code that has not been merged, fork the related branch and finish the functionality.
  • Work in progress pull request should have a 'WIP' before the pull request title.
  • Please do not include merge commits in your Pull Request. Instead, use git rebase to make the commit history linear.

Commit Message Guidelines

We have very precise rules over how our git commit messages can be formatted. This leads to more readable messages that are easy to follow when looking through the project history.

Commit Message Format

Each commit message consists of a header, a body (optional) and a footer (optional). The header has a special format that includes a type, a scope and a subject:

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

The header is mandatory and the scope of the header is optional.

Any line of the commit message cannot be longer than 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.

The footer should contain a closing reference to an issue if any.

Samples: (even more samples)

docs(changelog): update changelog to beta.5

fix(release): need to depend on the latest rxjs and zone.js

The version in our package.json gets copied to the one we publish, and users need the latest of these.

Revert

If the commit reverts a previous commit, it should begin with revert: , followed by the header of the reverted commit. In the body, it should say: This reverts commit <hash>., where the hash is the SHA of the commit being reverted.

Type

Must be one of the following:

  • build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
  • ci: Changes to our CI configuration files and scripts (example scopes: Circle, BrowserStack, SauceLabs)
  • docs: Documentation only changes
  • feat: A new feature
  • fix: A bug fix
  • perf: A code change that improves performance
  • refactor: A code change that neither fixes a bug nor adds a feature
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • test: Adding missing tests or correcting existing tests
  • chore: Other changes that cannot fit into any categories above (settings for Github hook, etc)

Scope

The scope should be the name of the component affected (as perceived by the person reading the changelog generated from commit messages).

The following is the list of currently supported scopes:

  • eda.distribution
  • eda.correlation
  • eda.missing
  • eda.data_array
  • connector
  • clean
Clone this wiki locally