|
|
Currently, I'm not accepting any contributions to the code base, since it's still in very early development phase. However, if you still want to help out and assuming you have a good understanding of the code base, you can help me add documentation to this wiki. Here are some guidelines to keep in mind for contributing:
|
|
|
|
|
|
###Class Pages:
|
|
|
* Start with a small introduction about the class itself, and some basic overview of what it does.
|
|
|
* Secondly use this header to document about what the constructor and the destructor does: ####Constructor and Destructor:
|
|
|
* To document the member variables and member functions, use a table of these formats:
|
|
|
|
|
|
####Member variables:
|
|
|
|Name|Type|Visibility|Description|
|
|
|
|-------------|----|----------|-----------|
|
|
|
|
|
|
####Member functions:
|
|
|
|Name|Return Type|Visibility|Description|
|
|
|
|-------------|-----------|----------|-----------|
|
|
|
|
|
|
* Use coding syntax when mentioning member variables and functions, visibility as well as most variable types. If the variable is an object defined in this project, then hyperlink the object's wiki page to the text.
|
|
|
* The description for the variables and functions should be short yet descriptive. Do not discuss implementation, rather just describe their functions. Oh and no full stops, keep it one sentence.
|
|
|
* As for referencing objects anywhere in the text, do the same thing as you did in the tables, hyperlink them to their specific wiki page.
|
|
|
|
|
|
As an example and reference, take a look at the [Core Engine](https://github.com/sadmansk/GameEngine/wiki/Core-Engine-Class) page.
|
|
|
|
|
|
*Thank you for considering to contribute.* |
|
|
\ No newline at end of file |