WARG members often find that joining this team requires more knowledge and has a larger learning curve than other student teams. Once members have acquired this knowledge they gain a lot of confidence and are able to make large contributions to the team. Therefore, this Bootcamp is designed as a first task to be completed to both help you through the learning curve and to familiarize you with our system and conventions. The hope is that once you complete this Bootcamp you will feel confident and hopefully have acquired enough skills such that you are ready to take on tasks with the main software project! Just a quick disclaimer, this Bootcamp will help accelerate and minimize the learning curve but it will not give you all knowledge. The remaining knowledge will be acquired through completing other tasks with the team.
Forks can be created using the fork button in the top right of the Github Interface (you need to be signed into a Github account).
Clone your fork with either:
git clone [email protected]:YOUR_USERNAME_HERE/computer-vision-bootcamp.git
if you want to use ssh or
git clone https://github.com/YOUR_USERNAME_HERE/computer-vision-bootcamp.git
for https
Note that you will need to have CMake installed so that you can build your module once you've written it.
Your task is to implement something
Since the point of this bootcamp it to familiarize you with our system, it does not really matter what task you choose, however we strongly recommend choosing something relevant to the libraries that we use, predominantly OpenCV, and the type of software we are creating and implement something with that in mind.
Your code must be implemented as a submodule and must:
- Follow our style guide
- Build using CMake
- Be well documented using doxygen-formatted comments
- Be tested using our testing framework
See contributing for an example and more information.
To submit your bootcamp project you should create a pull request. Note that this does not mean you are done, we will review your pull request and give you feedback and you will be expected to update it so that if meets all requirements.
Once your pull request has been merged you are ready to work on the Computer Vision project.