pros-openlib

What is Openlib?

Openlib is a collection of libraries for use in VEX Robotics, each library is thouroughly tested and anyone is open to contribute.

Library structure

Each library is organized into their own folder which includes all source files plus info.txt describing its usage, authors, and license (if any). If no license is specified it will fall under CC0 (Public Domain) https://creativecommons.org/publicdomain/zero/1.0/ In PROS projects (if required) may contain their own Makefile and additional instructions on how to build and use.

Code quality requirements (PROS)

• (should go without saying) Use comments unless the code's functionality is obvious
• Describe all your API functions in the project's info.txt
• You should always use headers
• Mark undocumented globals as static
• Use static const instead of #define for globals whenever possible
• camelCase for functions, CamelCase for classes
• #pragma once is neater than normal header guards
• Dont mix and match syntax styles inside of projects! ie choose between void* foo and void *foo then stick with it
• Future proof. avoid having to deprecate functions in the future.
• Put some examples in an examples sub folder if possible
• TEST YOUR CODE BEFORE PUSHING!

Issue tracker

The issue tracker is not a support forum, only post if you are certain it is a bug in the library's code or if you are requesting a feature

Please put the name of the library in the title of the issue, for example [PID] Robot spinning in circles and share code that can reproduce the issue.