Skip to content

Latest commit

 

History

History
79 lines (52 loc) · 2.51 KB

CONTRIBUTING.md

File metadata and controls

79 lines (52 loc) · 2.51 KB
Raw

Contributing

Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.

What you'll need

  1. Approved Bug or Feature
  2. Node LTS
  3. Docker Desktop

To work with operations:

  1. Kind
  2. Helm

Setup

$ npm run env
$ npm run ci
$ npm run transpile
$ docker compose up -d

If you want to run components using CLI with local environment (from docker-compose), set TAO_DEV environment variable to 1.

$ export TOA_DEV=1

Discipline

Please follow the Cycle.

Code style

Project uses JavaScript and TypeScript standard style with some additional rules. Please make sure your IDE respects .editorconfig.

Branching model

Please follow Gitflow. Name feature branches as feat/feature-name.

Commits

Commit Granularity

Small commits are better than big ones.

If you find yourself confused when you should commit changes, imagine you have a permanent question from your boss: What have you done? Then, each time you have a reasonable answer to it, you should commit. And that answer should be your commit message (conforming to the commit message convention).

Commit Messages Conventional Commits

Please use Conventional Commits.

Commit subject line should complete the sentence:

If applied, this commit will [add your subject line here]

The commit message should focus on describing the change being made, rather than explaining the motivation behind the change.

Clean Commits

A subject of a commit is a set of units of work, that is a set of finished TDD cycles, thus all existent unit tests must pass and changed files must not contain TODOs (if you're not going to do it now, create an issue).

Versioning

Feature branches must not change versions. Version is updated when PR is merged to the dev branch.