Skip to content

Latest commit

 

History

History
63 lines (37 loc) · 3.55 KB

GUIDELINES.md

File metadata and controls

63 lines (37 loc) · 3.55 KB
Raw

Development Guidelines

These are the general guidelines for everyone who wishes to contribute to this project.

Developing For This Project

Thank you very much for your time and interest in this project!

We greatly appreciate that you are here, interested either developing for this project, reporting a bug or making a suggestion

Please read on how to help.

Development Workflow

  1. If you would like to help with code and/or multimedia assets, you will need a GitHub account.
  2. Then you create a fork from the main branch.
  3. In your fork create a new branch with a descriptive name of what you are doing or changing. If you are working on spelling improvements, then a good name for your branch will be "SpellingWork". If you are reducing the code size, then a good name would be "CodeRedux"
  4. Test your changes, test your code, your assets or whatever you are changing.
  5. Commit your work to your newly descriptively namely branch in your fork.
  6. Test your work again.
  7. Once you are sure it doesn't break anything, then create a Pull Request to the dev branch of the project.
  8. Your PR will be tested by team and if all works well, it will be merged. There is no guarantee or assurance that your contribution will be merged into either dev or main branches and changes might be requested before your contribution is accepted if accepted at all.

Branches

  • main is the default branch where we put the code that has been tested and it's known to work well.
  • dev is the branch where work happens, where PR's are made to and, where we add new features. Once new features and contributions are well tested in the dev branch they are merged into the main branch.

Coding Style

Below are some advice on how we expect your code to look like.

If you don't like this, it's ok, simply don't code for this project.

Indentation

Tab vs Spaces

  • We use spaces instead of tabs. This should be transparent to your text editor, we juts ask you to have tabs converted into spaces so the identation looks the same to everyone no matter the editor they are using.

Tab size.

  • Use 4 spaces for a "tab", to indent the code.
  • If the nesting is too long, then indents of 2 spaces are accepted, as long as it is kept consistent.

Bug Reporting and Making Suggestions

Everyone, developers, users and alike are more than welcome to report bugs and make suggestions. A GitHub account will be required.

About Bug Reporting and Suggestions

Bugs

Bugs are things that are not working as expected. Crashes can be caused by bugs as well. If you found any bug or something is not behaving as expected or as it should, please report it!

Suggestions

If there is something that although is working properly, but you'd like to be done in a different way, or if you have a suggestion on how to improve something, then you are welcome to create an issue and submit your suggestion.

Creating An Issue

Reporting a bug and making a suggestion are done by creating and issue.