Skip to content

Commit c199fb7

Browse files
committed
fix spacing issues
1 parent 6fe00b4 commit c199fb7

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

CONTRIBUTING.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,11 @@ There are two main ways to contribute to the compatibility layer: reporting an i
2323

2424
Use this method when a plugin is incompatible and requires manual user action, or when there is no programmatic fix. These notices appear in the WordPress Site Health tool.
2525

26-
1. **Choose the correct category in `inc/site-health.php`:**
27-
* **`get_compatibility_manual_fixes()`**: For plugins that require specific manual configuration. The user will be told a "Manual Fix Required".
28-
* **`get_compatibility_review_fixes()`**: For plugins that are partially or fully incompatible. The user will see statuses like "Incompatible" or "Partial Compatibility".
26+
1. **Choose the correct category in `inc/site-health.php`:**
27+
* **`get_compatibility_manual_fixes()`**: For plugins that require specific manual configuration. The user will be told a "Manual Fix Required".
28+
* **`get_compatibility_review_fixes()`**: For plugins that are partially or fully incompatible. The user will see statuses like "Incompatible" or "Partial Compatibility".
2929

30-
2. **Add the plugin to the appropriate function's `$plugins` array.**
30+
2. **Add the plugin to the appropriate function's `$plugins` array.**
3131

3232
*Example (Adding a "Manual Fix Required" notice):*
3333
```php
@@ -48,16 +48,16 @@ Use this method when you can fix an incompatibility with code. This involves cre
4848

4949
#### Understanding the Classes
5050

51-
* **Compatibility Class (The "When"):** This class is the trigger. It tells the system *when* to run a fix for a specific plugin. It extends `Pantheon\Compatibility\Base` and is stored in `inc/compatibility/`. Its primary job is to define the conditions for the fix (e.g., run on every page load, only on activation).
51+
* **Compatibility Class (The "When"):** This class is the trigger. It tells the system *when* to run a fix for a specific plugin. It extends `Pantheon\Compatibility\Base` and is stored in `inc/compatibility/`. Its primary job is to define the conditions for the fix (e.g., run on every page load, only on activation).
5252

53-
* **Fix Class (The "What"):** This class contains the *actual code* that solves the problem (e.g., defines a constant, adds a filter). It is stored in `inc/compatibility/fixes/`. **Using a separate Fix Class is optional but highly recommended for clarity and reusability.** For very simple, one-line fixes, you can place the logic directly in the Compatibility Class. For anything more complex, or for logic that could be reused (like `DefineConstantFix`), a Fix Class is the best practice.
53+
* **Fix Class (The "What"):** This class contains the *actual code* that solves the problem (e.g., defines a constant, adds a filter). It is stored in `inc/compatibility/fixes/`. **Using a separate Fix Class is optional but highly recommended for clarity and reusability.** For very simple, one-line fixes, you can place the logic directly in the Compatibility Class. For anything more complex, or for logic that could be reused (like `DefineConstantFix`), a Fix Class is the best practice.
5454

5555
#### How to Implement an Automated Fix
5656

57-
1. **Create the Compatibility Class (Required):**
58-
* Create a new file in `inc/compatibility/` named `class-{plugin-name}.php`.
59-
* The class must extend `Pantheon\Compatibility\Base`.
60-
* You must implement the `apply_fix()` and `remove_fix()` methods, even if their bodies are empty.
57+
1. **Create the Compatibility Class (Required):**
58+
* Create a new file in `inc/compatibility/` named `class-{plugin-name}.php`.
59+
* The class must extend `Pantheon\Compatibility\Base`.
60+
* You must implement the `apply_fix()` and `remove_fix()` methods, even if their bodies are empty.
6161
* Set a property like `$run_fix_everytime = true;` to control when the fix runs.
6262

6363
2. **Implement the Fix Logic (Choose One):**

0 commit comments

Comments
 (0)