Takamaru

Messages gem for Sasori microservices.

Initial config

⚠️ Please, run the following steps the first time you pull this repository.

• This workspace has extension reccomendations for Visual Studio Code; please, install all of them at the first run.
• Also, open the folder /workspace/takamaru at the first run.
• Tell git where to find the project shared hooks: git config core.hooksPath .githooks.
• Tell git flow where to find the project shared hooks: git config gitflow.path.hooks .githooks.
• Then setup git flow with the following command: git flow init -f -d --bugfix bugfix/ --feature feature/ --hotfix hotfix/ --release release/ --support support/ --tag ''.
• Run bundle to install all the gems.

Generators

Takamaru has one generator, takamaru:install. It writes, but does not run, a migration file. The migration creates the commit log table.

Code Style

Rubocop gem is enabled by default in devcontainer and will automatically format files on save and check all the project before commit.

Ruby Style Guide gem is the source for our style guide. We changed just a little of config in the .rubocop.yml file.

Code quality

To run all the quality checks together use the this command:

$ rails code_quality:check

RubyCritic gem should be used from cli to generate html report in /tmp/rubycritic. Simply run the command rubycritic from workspace root path.

Bundler audit gem should be used from cli to generate a json report in /tmp/bundler-audit.json. Simply run the command bundle-audit from workspace root path.