Style Guides

Python

Format all files using black.
Check the code for problems using flake8.
- Some excluded rules are contained in .flake8.
- These exclusion are to avoid conflicts between black and flake8.
Sort your import using isort.
These guides are checked by pre-commits, github workflow on submitting Pull Requests.

Format all files using prettier.
- Rules are defined in frontend/.prettierrc.json.
Check the code for problems using eslint.
- Rules are defined in frontend/.eslintrc.json.

If you are using VSCode, you can use features (like format/lint on save) by installing and activating the extensions in .vscode/extensions.json.
For these extensions, we provide example settings in .vscode/settings.example.json
- To use this,
  - cp .vscode/settings.example.json .vscode/settings.json
  - then edit .vscode/settings.json following the comment in the file.
    - Uncomment the line // "flake8.path": ["conda", "run", "-n", "optinist_dev", "python", "-m", "flake8"],
    - and set optinist_dev to your conda environment name.

Though automatically checked with pre-commit, you can check your code follow the guide before commit.
Run the following command to check linting and format your code.
```
make format
```