2020-01-26 04:10:37 +00:00
|
|
|
General
|
|
|
|
|
=======
|
|
|
|
|
|
2020-01-26 03:55:58 +00:00
|
|
|
* Test your contributions to assure they do not break existing functionality.
|
|
|
|
|
* Commits to the repo should be done by portions; that is, by individual functionalities of the program.
|
2020-01-26 04:10:37 +00:00
|
|
|
* Don't use any disrespectful language.
|
|
|
|
|
|
|
|
|
|
Code
|
|
|
|
|
=======
|
|
|
|
|
|
|
|
|
|
* Make sure the code can compile for all target systems - Windows, Linux, and macOS/Mac OS X.
|
|
|
|
|
* All code must be compatible with at least C++11.
|
2020-02-28 04:03:01 +00:00
|
|
|
* Minimize the amount of redundant code.
|
|
|
|
|
* Avoid using absolute paths for the headers.
|
|
|
|
|
* Code should maintain vertical alignment. An example of this is provided below:
|
|
|
|
|
|
|
|
|
|
> one_hundred = 100;
|
|
|
|
|
> one_thousand = 1000;
|
|
|
|
|
|
|
|
|
|
** The following should be avoided:
|
|
|
|
|
|
|
|
|
|
> one_hundred = 100;
|
|
|
|
|
> one_thousand = 1000;
|
|
|
|
|
* CamelCase for class names, lowercase for variables, UPPERCASE for enumerations
|
2020-01-26 04:10:37 +00:00
|
|
|
|
|
|
|
|
Issues
|
|
|
|
|
=======
|
|
|
|
|
|
|
|
|
|
* When creating an issue ticket, note which version you are using.
|
|
|
|
|
* If possible, reference the git hashes for the relevant commits.
|
|
|
|
|
* Once an issue is closed, do not re-open it. Instead, reference it in a new issue ticket.
|
