feat: add a Testing documentation to the project (#92)

* feat: add a Testing documentation to the project

* feat: Take into account PR comments

Author: thomasrebam

README.md

@@ -30,6 +30,8 @@ Here are some useful commands:
 - rename the directory of a package: `mv package-my-config new-directory-name && yarn lerna bootstrap`,
 - run a script `do-something` that exists in at least one package: `yarn lerna run do-something` (this will try to run the script in all packages in which it is defined).
 
+- [Testing ESLint plugin](https://github.com/bamlab/react-native-project-config/blob/main/packages/eslint-plugin/docs/Testing.md)
+
 ## Conventional commits
 
 We use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) to automate the release process.

packages/eslint-plugin/docs/Testing.md

@@ -0,0 +1,32 @@
+# Testing
+
+## Introduction
+
+This document provides information about how to test the eslint-plugin after adding or removing rules.
+
+## Example-app
+
+The example-app folder is located at the root of `react-native-project-config`.
+The goal of each file of example-app is to simulate the behavior of a rule or a set of rules, so that you can visually check it or by running the `yarn lint` command.
+When you add or remove a rule from the recommended config, please modify (or add/remove) the corresponding file in the example-app folder.
+
+## Real example testing
+
+In order to test that your rule will be properly deployed, use another project, in which you install the eslint-plugin from your local files.
+Use the command `yarn remove @bam.tech/eslint-plugin; yarn add --dev file:/project_address/react-native-project-config/packages/eslint-plugin; yarn; yarn lint` to remove the plugin from installed dependencies, and add it again.
+If not done already, add the plugin to your `.eslintrc` configuration :
+
+```json
+// .eslintrc
+{
+  "extends": "plugin:@bam.tech/recommended",
+  "overrides": [
+    {
+      "files": ["*.test.tsx", "*.test.ts"],
+      "extends": "plugin:@bam.tech/tests"
+    }
+  ]
+}
+```
+
+You should be able to test your rules from the plugin.