Skip to content

Latest commit

 

History

History
47 lines (33 loc) · 1.33 KB

CONTRIBUTING.md

File metadata and controls

47 lines (33 loc) · 1.33 KB

Contributing

Clone for development

Clone the repository and create a local branch with what you want to add:

feature/explain_your_feature, fix/explain_your_fix and so on and start writing your code.

To start the application check ReadMe-Developer-Manual.md

Project structure

.
├── dist      // code output
├── src       // source code
├── test      // test e2e files

Commit rules

Commit message

Please include in your commit message what you changed and if required why.

It should :

  • contain a short description of the change (preferably 50 characters or less)
  • be prefixed with one of the following tags
    • wip(work in progress): partial implementation
    • fix : bug fix
    • feat or feature : new feature
    • update: updated features but no breaking changes in the API
    • doc or docs : documentation updates
    • BREAKING : if commit is a breaking change
    • refactor : code refactoring (no functional change)
    • test : tests and CI updates
    • chore : updates for toolchain(webpack rules, update/upgrade dependencies and so on)
    • release : updates in the version number
    • demo : demo files
    • data : data change

example: git commit -m "feat,test: functionality to do X was implemented and tested"

Code linting

Before publishing, please lint the code using the npm run lint command.