2014-08-28 14:55:23 +00:00
## How to report a bug
Read the following before reporting a bug on GitHub:
2016-01-31 11:47:00 +00:00
1. Update Lychee to the newest version
2. Update your browser to the newest version
2014-08-28 14:55:23 +00:00
2. Take a look in the [FAQ ](https://github.com/electerious/Lychee/blob/master/docs/FAQ.md )
3. Check if someone has [already reported ](https://github.com/electerious/Lychee/issues ) 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
2016-01-31 11:47:00 +00:00
- Output of the diagnostics (`plugins/Diagnostics/index.php`)
2014-10-25 18:28:47 +00:00
- Browser and system version
2014-08-28 14:55:23 +00:00
- 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**:< br >
2016-01-31 11:47:00 +00:00
Use tabs for indentation. Spaces for alignment.
2014-08-28 14:55:23 +00:00
- **Naming**:< br >
Keep variable and method names concise and descriptive.
- **Quotes**:< br >
Single-quoted strings are preferred to double-quoted strings
2016-01-31 11:47:00 +00:00
2014-08-28 14:55:23 +00:00
- **Comments**:< br >
2016-01-31 11:47:00 +00:00
Please use single-line comments to annotate significant additions. Use `//` for comments in PHP, 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.
