Software for AlbertaLoop's first-generation pod.
A rendering of the pod's aeroshell.
An initial mock-up of the electronics layout.
We use pre-commit hooks to ensure code standardisation. These hooks will automatically make changes to staged code, based on the rules configured in pre-commit-config.yaml.
You will have to install pre-commit to make changes to the repository. To install pre-commit, follow the instructions on the website. The install would look something like this on Linux:
0. open a terminal and change to the repository directory cd T_SWE_2019_2020/
- create a virtual Python environment
virtualenv venv - source the environment
source venv - add pre-commit package
pip install pre-commit - install git hooks script
pre-commit install
And that's it! You will not even need to source your environment each time you program. Just start programming!
The general guideline for Github is to always develop on your own branch. After a feature is ready, create a pull request for the branch you are working on and have a senior member of the team review and approve your pull request. Once a pull request has been approved, it can be merged into the master branch. If you are unsure of how to merge, please ask a senior member of the team for guidance.
Use "-" character to separate words in a branch name. Example: rutvik-gui. Try to name each branch to highlight who is working on the feature, and what the feature is.
Commit messages must accurately and briefly explain what change you are making. Try to be concise.