update

CONTRIBUTING.md

@@ -32,8 +32,8 @@ This document describes rules that are in effect for this repository, meant for
 6. Issues with feature requests should be discussed for viability/desirability.
 7. Feature requests or changes that are meant to address a very specific/limited use case, especially if at the expense of increased code complexity, may be denied, or may be required to be redesigned, generalized, or simplified.
 8. Feature requests that are not accompanied by a PR:
-    * could be closed immediately (denied).
-    * could be closed after some predetermined period of time (left as candidate for somebody to pick up).
+    - could be closed immediately (denied).
+    - could be closed after some predetermined period of time (left as candidate for somebody to pick up).
 9. In some cases, feedback may be requested from the issue reporter, either as additional info for clarification, additional testing, or other. If no feedback is provided, the issue may be closed by a contributor or after 40 days by the STALE bot.
 
 ## Pull requests
@@ -49,17 +49,17 @@ The process is straight-forward.
 - Create a Pull Request against the [**dev**](https://github.com/emsesp/EMS-ESP32/tree/dev) branch of EMS-ESP.
 
 1. All pull requests must be done against the dev branch.
-2. Make sure code is formatting per the `.clang-format`
-3. Only relevant files should be touched (Also beware if your editor has auto-formatting feature enabled).
-4. Only one feature/fix should be added per PR.
-5. PRs that don't compile (fail in CI Tests) or cause coding errors will not be merged. Please fix the issue. Same goes for PRs that are raised against older commit in dev - you might need to rebase and resolve conflicts.
-6. All pull requests should undergo peer review by at least one contributor other than the creator, excepts for the owner.
-7. All pull requests should consider updates to the documentation.
-8. Pull requests that address an outstanding issue, particularly an issue deemed to be severe, should be given priority.
-9. If a PR is accepted, then it should undergo review and updated based on the feedback provided, then merged.
-10. By submitting a PR, it is needed to use the provided PR template and check all boxes, performing the required tasks and accepting the CLA.
-11. Pull requests that don't meet the above will be denied and closed.
-
+2. Make sure code is formatting per the `.clang-format`.
+3. Make sure any new code is clearly commented explaining what the function/logic does.
+4. Only relevant files should be touched (Also beware if your editor has auto-formatting feature enabled).
+5. Only one feature/fix should be added per PR.
+6. PRs that don't compile (fail in CI Tests) or cause coding errors will not be merged. Please fix the issue. Same goes for PRs that are raised against older commit in dev - you might need to rebase and resolve conflicts.
+7. All pull requests should undergo peer review by at least one contributor other than the creator, excepts for the owner.
+8. All pull requests should consider updates to the documentation.
+9. Pull requests that address an outstanding issue, particularly an issue deemed to be severe, should be given priority.
+10. If a PR is accepted, then it should undergo review and updated based on the feedback provided, then merged.
+11. By submitting a PR, it is needed to use the provided PR template and check all boxes, performing the required tasks and accepting the CLA.
+12. Pull requests that don't meet the above will be denied and closed.
 
 ## Semantic Commit Messages
 
@@ -92,7 +92,7 @@ More Examples:
 
 References:
 
-- https://www.conventionalcommits.org/
+- <https://www.conventionalcommits.org/>
 
 --------------------------------------