David A. Windham
david
/
lychee
1
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Branch: develop
Branches Tags
lychee
/
CONTRIBUTING.md

CONTRIBUTING.md 1.4 KB
Permalink History Raw

How to report a bug

Read the following before reporting a bug on GitHub:

  1. Update to the newest version of Lychee
  2. Update your Browser to the newest version
  3. Take a look in the FAQ
  4. Check if someone has already reported the same bug

When reporting a bug on GitHub, make sure you include the following information:

  • Detailed description of the problem
  • How to reproduce the issue (step-by-step)
  • What you have already tried
  • Output of the diagnostics (plugins/check/index.php)
  • Browser and system version
  • Attach files when you have problems which specific photos

Coding Guidelines

Check if there are branches newer than master. Always fork the newest available branch.

Please follow the conventions already established in the code.

  • Spacing:
    Use tabs for indentation. No spaces.

  • Naming:
    Keep variable and method names concise and descriptive.

  • Quotes:
    Single-quoted strings are preferred to double-quoted strings

  • Comments:
    Please use single-line comments to annotate significant additions. Use # for comments in PHP; // for comments in JS and CSS.

Merge your changes when the forked branch has been updated in the meanwhile. Make sure your code is 100% working before creating a Pull-Request on GitHub.