- During development, switch to the branch for the current milestone before pushing files to the repo.
- When committing changes, try to reference relevant issues by including
#X in your commit message, where X is the reference number of the issue.
git commit -m "Add basic movement functions #2"
git commit -m "#2 Add basic movement functions"
- For integration's sakes, it is recommended to encode functionalities as classes and functions residing in
libraries/.
- The controller will need to pass its
Robot instance to any functionality class or function it calls.
- After integration, files no longer needed for the milestone should be moved to
archive/.
- After testing completes, the milestone branch will be merged into
main.
- The file structure tries to emulate a Webots project directory. Python scripts are either in
controllers/ or libraries/.
- Webots automatically detects controllers if they follow structure
controllers/xyz_controller/xyz_controller.py.
- It is recommended to follow PEP 8 style guide.