21 Coding style policy

LogMANOriginal edited this page 2019-11-01 18:05:06 +01:00

This section explains the coding style policy for RSS-Bridge with examples and references to external resources. Please make sure your code is compliant before opening a pull request.

RSS-Bridge uses Travis-CI to validate code quality. You will automatically be notified if issues were found in your pull request. You must fix those issues before the pull request will be merged. Refer to phpcs.xml for a complete list of policies enforced by Travis-CI.

If you want to run the checks locally, make sure you have phpcs and phpunit installed on your machine and run following commands in the root directory of RSS-Bridge (tested on Debian):

phpcs . --standard=phpcs.xml --warning-severity=0 --extensions=php -p
phpunit --configuration=phpunit.xml --include-path=lib/

The following list provides an overview of all policies applied to RSS-Bridge. Find more information on the corresponding Wiki page.

• Whitespace
  • Add a new line at the end of a file
  • Do not add a whitespace before a semicolon
  • Do not add whitespace at start or end of a file or end of a line
• Indentation
  • Use tabs for indentation
• Maximum line length
  • The maximum line length should not exceed 80 characters
• Strings
  • Whenever possible use single quoted strings
  • Add spaces around the concatenation operator
  • Use a single string instead of concatenating
• Constants
  • Use UPPERCASE for constants
• Keywords
  • Use lowercase for true, false and null
• Operators
  • Operators must have a space around them
• Functions
  • Parameters with default values must appear last in functions
  • Calling functions
  • Do not add spaces after opening or before closing bracket
• Structures
  • Structures must always be formatted as multi-line blocks
• If-Statement
  • Use elseif instead of else if
  • Do not write empty statements
  • Do not write unconditional if-statements
• Classes
  • Use PascalCase for class names
  • Do not use final statements inside final classes
  • Do not override methods to call their parent
  • abstract and final declarations MUST precede the visibility declaration
  • static declaration MUST come after the visibility declaration
• Casting
  • Do not add spaces when casting
• Arrays
  • Always use the long array syntax

Important for editors: Make sure to keep CONTRIBUTING.md in sync!

RSS-Bridge · Reconnecting the Web ·