From 05325b135d03c64b71c5373d4846897edd443ba8 Mon Sep 17 00:00:00 2001 From: Hampton Ford Date: Sun, 15 May 2022 23:40:06 -0600 Subject: [PATCH] Fix and improve the docs Co-authored-by: Chocobo1 PR #17034. --- CODING_GUIDELINES.md | 7 ++++--- CONTRIBUTING.md | 4 ++-- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/CODING_GUIDELINES.md b/CODING_GUIDELINES.md index 0d1ffdb1d..0bbf0e2c6 100644 --- a/CODING_GUIDELINES.md +++ b/CODING_GUIDELINES.md @@ -1,6 +1,7 @@ # Coding Guidelines -All new code **must** follow the following coding guidelines. \ +All new code **must** follow the following coding guidelines. + If you make changes in a file that still uses another coding style, make sure that you follow these guidelines for your changes. \ For programming languages other than C++ (e.g. JavaScript) used in this repository and submodules, unless otherwise specified, coding guidelines listed here applies as much as possible. @@ -456,8 +457,8 @@ class ExampleWidget : public QWidget * Prefer pre-increment, pre-decrement operators ```c++ - ++i, --j; // Yes - i++, j--; // No + ++i, --j; // yes + i++, j--; // no ``` * private/public/protected must not be indented diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0ad5fefdc..409ff8030 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,7 +23,7 @@ Read the respective section to find out more. * **Be patient.** The development team is small and resource limited. Developers and contributors take from their free time to analyze the problem and fix the issue. :clock3: -* Harsh words or threats won't help your situation. What's worse, your complain will (very likely) be **ignored.** :fearful: +* Harsh words or threats won't help your situation. Your complaint will (very likely) be **ignored.** :fearful: # Submitting an issue/bug report @@ -39,7 +39,7 @@ Developers and contributors are not supposed to deal with issues for which littl Positive contributions are those which are reported with efforts to find the actual cause of an issue, or at the very least efforts were made to narrow it as much as possible. -Requiring people to investigate as much as possible before opening an issue will more than likely avoid burdening the project with invalid issues or issues unrelated to qBittorrent. +Requiring people to investigate as much as possible before opening an issue avoids burdening the project with invalid issues or issues unrelated to qBittorrent. The following are _not_ bug reports. **Check the [wiki][wiki-url], [forum][forum-url] or other places for help and support for issues like these**: