diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cc00b9f..86eed15 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,8 +2,8 @@ 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 +1. Update Lychee to the newest version +2. Update your browser to the newest version 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 @@ -12,7 +12,7 @@ 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`) +- Output of the diagnostics (`plugins/Diagnostics/index.php`) - Browser and system version - Attach files when you have problems which specific photos @@ -23,15 +23,15 @@ Check if there are branches newer than `master`. Always fork the newest availabl Please follow the conventions already established in the code. - **Spacing**:
- Use tabs for indentation. No spaces. + Use tabs for indentation. Spaces for alignment. - **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. + 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. \ No newline at end of file