Skip to content

Latest commit

 

History

History
122 lines (77 loc) · 3.31 KB

CONTRIBUTING.md

File metadata and controls

122 lines (77 loc) · 3.31 KB
Raw

Contribution Guidelines

Table of Contents

Commit Message Guidelines

  • Commit messages must begin with the issue number (if applicable) in square brackets.

  • The issue number can be omitted, when the commit does not relate to a specific issue.

  • Commit messages must be written in present-tense.

  • If more detail is required, add a paragraph after the message separated by a newline character.

  • There must not be punctuation in the commit message.

  • Both the title and the body must use proper grammar.

    Example:

    [#71] Add basic set of Contribution Guidelines

Create the basic set of coding style guidelines for the project.

Merge Request Guidelines

  • The title of a merge request must not contain an issue number

  • The title must describe the goal of the merge request.

  • The body of the merge request must describe the changes made in further detail if needed.

  • The body of the merge request must list the issues that the merge request will close.

    Example:

    Title: Start Android Studio Project

Body:

Creates a basic "EmptyActivity" Android Application. This will be the starting point for the Wave Music Player.

Closes
- #67

Code Style Guidelines

Indentation

  • Use the default TAB character in Android Studio.

Braces

  • Braces must always be used, even around loops or if statements that only have a one-line body.

New Line

  • Place opening braces on a new line.
  • Place closing braces on a new line.
    • The exception is empty code blocks, which can have their opening and closing braces on the same line.
  • Place the else of an if-else statement on a new line.
  • Place the catch and finally of a try-catch on a new line.

Variables

  • Variables and functions must use camelCase.
  • Constants must use UPPERCASE_SEPARATED_WITH_UNDERSCORES.
  • Boolean variables must use a verb like is or has, which describes the boolean.

Functions

  • Functions must use camelCase.
  • Function names must begin with a verb.
  • Functions that are being overridden must use the @Override notation before the function signature, but after the function block comment.
  • Functions that are being overloaded must place the new parameters after the set of existing parameters.

Classes

  • Classes must use UpperCase.

Interfaces

  • Interface names must be prefixed with I

Comments

  • All comments must be a full sentence, with punctuation and correct grammar.

  • In-line comments should not be placed on the same line as code.

  • A comment must be placed before class signatures describing their purpose.

  • A block comment must be placed before method signatures, describing the following:

    • The functionality and purpose of the method.
    • The input parameters of the method, if any.
    • The return value of the method, if any.

    Example:

    /**
 * Checks if the given object is equal to this one.
 *
 * @param variable1 The desired object to compare.
 *
 * @return A boolean that is true, if the two objects are equal.
 */
public boolean equals(Object variable1)
{
  //Do something
  return true;
}