etherlabsio / ai-engine

Core AI services and functions powering the ETHER Platform
MIT License
0 stars 0 forks source link

Refactor/repo codestyle #157

Closed shashankpr closed 4 years ago

shashankpr commented 4 years ago

Changes

Instructions

The following instructions should help in setting up pre-commit hooks locally and mentions few steps to ensure if the code being committed has style or runtime warnings.

  1. To Install Commit hooks: Follow the instructions mentioned in this link. The pre-commit config file is already configured in the ai-engine repo, so it will just use everything from it.
  2. Once installed, everytime a git commit op is performed, the code being committed is checked against black and flake8 formatter. If the warnings need to be ignored for some reason, then use git commit -n
  3. Install this package: https://github.com/nektos/act. It allows us to run the github action locally to replicate and verify what warnings would be thrown upon performing push or pull_request.

Next action

This way we can use this PR to address all the refactoring and CI changes for the existing codebase and merge it to develop. Later by following the steps for local setup, we can ensure that we will all uniformly follow the same guide before even pushing changes.

Comment and modify/remove the procedures as needed.

shashankpr commented 4 years ago

@etherlabsio/ml Made changes to services and pkgs that I have used/authored

shashankpr commented 4 years ago

Merging this for now so that current changes can be code reviewed for changes.