Skip to content

Guidelines.md

Latest commit

 

History

History
40 lines (25 loc) · 1.8 KB

Guidelines.md

File metadata and controls

40 lines (25 loc) · 1.8 KB

Development Conventions and Guidelines

JavaScript Coding Guidelines

We enforce code style rules using ESLint. Execute npm run lint to check your code for style issues.
You may also find an ESLint integration for your favorite IDE here.

Testing

Unit testing is based on the ava test-framework. You can run all tests using npm test (this is what our CI will do for all pull requests).

During development, you might want to use npm run unit or npm run unit-watch (re-runs tests automatically after file changes) to quickly execute all unit tests and see whether your change just broke one of them. 😉

Git Guidelines

No Merge Commits

Please use rebase instead of merge to update a branch to the latest main. This helps keeping a clean commit history in the project.

Commit Message Style

This project uses the Conventional Commits specification to ensure a consistent way of dealing with commit messages.

feat: Allow coverage watermarks configuration via frontend

This feature enables the extension of default or ui5.yaml's Istanbul
configuration, so that certain settings could be adjusted from the
frontend.

Structure

type(scope): Description
  • required: every commit message has to start with a lowercase type. The project has defined a set of valid types.
  • optional: the scope is typically the affected module. If multiple modules are affected by the commit, skip it or define a meaningful abstract scope.
  • required: the description has to follow the Sentence Case style. Only the first word and proper nouns are written in uppercase.