Scroll down for Contribution Guidelines.
Prerequisites:
- Download and Install Git Bash
Read the official github guide on contributions here
Tl;dr
- Fork the repository
- Clone the repository locally:
git clone "url from your forked repo" - Create a new branch:
git switch -c your-new-branch - Make changes
- Push Changes:
git push -u origin your-branch-name - Open pull request from github website
Additional
- Keep your forked repository up to date: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork
This project will use Github Issues for feature requests, asking for help, reporting issues, etc. Please add the appropriate labels when creating a new issue, and be as descriptive as possible.
Coding Practices
- Use PascalCase for public members of classes (e.g
public float MyNumber;) - Use camelCase for private members of classes (e.g.
private Transform myTransform;) - Do not clutter Awake/Start/Update. Isolate and organize logic of different "sub-components" in their own methods, and call these methods in Update or wherever needed.
- On new scripts, describe the usage of said script at the top using a comment.
Naming Practices
I_MyInterface- "I_" prefix for interfaces.E_MyEnum- "E_" prefix for enums.BaseMyClass- "Base" prefix for base classes.delegate OnStatusChangedHandler(object source, MyEventArgs args)- "Handler" suffix for event handler, and "EventArgs" suffix for event args class.
Script Description Comment template:
////////////////////////////////////////////////////////////////////////////
//
// This component will enable flight controls on the gameobject it is placed on,
// giving the player steering control of the ship, using A, D or LeftArrow, RightArrow
//
// Attach ShipController to the ship game object.
//
////////////////////////////////////////////////////////////////////////////
Check out these features that can be worked on, while the main ideas of the game are being defined