Skip to content

Latest commit

 

History

History
22 lines (18 loc) · 886 Bytes

CONTRIBUTING.md

File metadata and controls

22 lines (18 loc) · 886 Bytes

Contributing to TheOne

Thank you for your interest in TheOne! Any contribution is welcome, including:

  • Reporting a bug
  • Submitting a fix
  • Proposing new features
  • Improving code quality

Report bugs using Github's issues

We use GitHub issues to track bugs. Report a bug by opening a new issue.

Coding Conventions

  • Class names: UpperCamelCase.
  • Public member variables: lowerCamelCase.
  • Function/Method names: UpperCamelCase.
  • Class member variables are located at the bottom of the file.
  • Tabs are preferred over spaces.
  • Avoid aligning variable names and values using tabulations.
  • Scope blocks should start on a new line.
  • Comment your functions, enums, classes, methods (Javadoc style)

Some coding conventions may have been overlooked during the writing of this document, so always refer to the existing codebase.