If you want to add/fix some code, please make the issue at first. Please comment and show any issues that need to be fixed before creating a PR.
You should fork from autoware-ml to own repository and make new branch. Please check AWML design document before implementation.
- We recommend some tools as below.
- Install black
pip install black- Install isort
pip install isort- Install pre-commit
pip install pre-commit- Formatting by manual command
# To use:
pre-commit run -a
# runs every time you commit in git
pre-commit install # ()- If you use VSCode, you can use tasks of VSCode.
- "Ctrl+shift+P" -> Select "Tasks: Run Task" -> Select "Pre-commit: Run"
- In addition to it, we recommend VSCode extension
If you add some feature, you must add the document like README.md.
The target of document is as below.
/docs/*: Design documents for developers
Design documents aims for developers. So please comment and show "why we should do" for documents.
/tools/*: Process documents for engineer users
Process documents aims for engineer users. So please comment and show "how we should do" for documents assuming that users know basic command linux around machine learning. You can assume the user can fix the bug in the tools on their own.
/pipelines/*: Process documents for non-engineer users
Process documents aims for non-engineer users. So please comment and show "how we should do" for documents assuming that users do not know basic linux command.
For now, integration test is done on local environment.
Please make PR and write the contents of it in English. When you make the PR, you check PR rule and the list of "Use case for contribution" in contribution docs.
When you get comments for PR, you should fix it.