Fixes

Author: forman

CONTRIBUTING.md

@@ -52,7 +52,7 @@ sort imports statements according to the default settings of
 Use `typing.TYPE_CHECKING` to resolve forward references 
 and effectively avoid circular dependencies.
 
-## Contributing Rules
+## Contributing a XRLint Rule
 
 ### Rule Naming
 
@@ -81,6 +81,7 @@ The rule naming conventions for XRLint are based ESLint:
   i.e., `<plugin>/rules/<rule>`. The module name should be the rule's name
   with dashes replaced by underscores. 
 
-* Write a comprehensive test for your rule logic using 
-  `xrlint.testing.RuleTester`. It should be defined in a dedicated 
-  test module, i.e., `tests/rules/test_<rule>`.
+* Write a comprehensive test for your rule logic which should be defined 
+  in a dedicated module under `tests`, i.e., `tests/rules/test_<rule>`. 
+  Consider using `xrlint.testing.RuleTester` which can save a lot of
+  time and is used for almost all in-built rules.

README.md

@@ -30,9 +30,9 @@ The following plugins provide XRLint's [inbuilt rules](https://bcdev.github.io/x
   [tidy data](https://tutorial.xarray.dev/intermediate/data_cleaning/05.1_intro.html)
   and the 
   [CF-Conventions](https://cfconventions.org/cf-conventions/cf-conventions.html).
-- `xrlint.plugins.core`: implementing the rules for 
+- `xrlint.plugins.xcube`: implementing the rules for 
   [xcube datasets](https://xcube.readthedocs.io/en/latest/cubespec.html).
   Note, this plugin is fully optional. You must manually configure 
-  it to apply its rules. It may be moved into a separate GitHub repo 
-  once XRLint is mature enough. 
+  it to apply its rules. It may be moved into a separate GitHub repo later. 
+
 

docs/index.md

@@ -29,6 +29,5 @@ The following plugins provide XRLint's [inbuilt rules](rule-ref.md):
 - `xcube`: implementing the rules for 
   [xcube datasets](https://xcube.readthedocs.io/en/latest/cubespec.html).
   Note, this plugin is fully optional. You must manually configure 
-  it to apply its rules. It may be moved into a separate GitHub repo 
-  once XRLint is mature enough. 
+  it to apply its rules. It may be moved into a separate GitHub repo later.