Feat/create how to contribute file (#20)

* feat: move content on how to contribute to a separate file

* feat: link the contributing file in the readme

---------

Co-authored-by: Clément Dours <clementdo@bam.tech>

Author: clementDours

packages/eslint-plugin/CONTRIBUTING.md

@@ -0,0 +1,60 @@
+# ESLint plugin for BAM
+
+This project is an ESLint plugin that gathers all the rules, plugins and parsers that should be used in any new BAM project. Here is the documentation on how to contribute to this plugin
+
+## How to improve?
+
+If you find a useful rule that you feel every project at BAM should use, feel free to open a PR.
+
+Use the documentation on how to create a shareable configuration [here](https://eslint.org/docs/latest/developer-guide/shareable-configs).
+
+Here is a small summary:
+
+### Adding new rules
+
+Adding new rules is quite simple, you just have to modify `index.js` and add your rule to the `rules` object:
+
+```js
+module.exports = {
+  ...
+  rules: {
+    ...
+    "my-new-rule": "error",
+  },
+  ...
+}
+```
+
+### Extending new shareable configurations
+
+Extending new shareable configurations is quite simple, you just have to modify `index.js` and add your shareable configuration to the `extends` array (the order of configurations is important):
+
+```js
+module.exports = {
+  ...
+  extends: [
+    ...
+    "@some-scope/eslint-config",
+  ],
+  ...
+}
+```
+
+The package containing your shareable configuration should be added as a dependency by running `yarn add your-package`.
+
+### Adding a plugin
+
+Adding a plugin is quite simple, you just have to modify `index.js` and add your plugin to the `plugins` array:
+
+```js
+module.exports = {
+  ...
+  plugins: [
+    ...
+    "your-plugin",
+  ],
+  ...
+}
+```
+
+The package containing your plugin should be added as a [peer dependency](https://classic.yarnpkg.com/en/docs/dependency-types/) by running `yarn add --peer your-plugin`.

packages/eslint-plugin/README.md

@@ -40,59 +40,4 @@ In your `.eslintrc` config file, extend the exported recommended configuration (
 
 You can still customize your ESLint config by adding configurations, plugins and rules to your `.eslintrc` config file.
 
-## How to improve?
-
-If you find a useful rule that you feel every project at BAM should use, feel free to open a PR.
-
-Use the documentation on how to create a shareable configuration [here](https://eslint.org/docs/latest/developer-guide/shareable-configs).
-
-Here is a small summary:
-
-### Adding new rules
-
-Adding new rules is quite simple, you just have to modify `index.js` and add your rule to the `rules` object:
-
-```js
-module.exports = {
-  ...
-  rules: {
-    ...
-    "my-new-rule": "error",
-  },
-  ...
-}
-```
-
-### Extending new shareable configurations
-
-Extending new shareable configurations is quite simple, you just have to modify `index.js` and add your shareable configuration to the `extends` array (the order of configurations is important):
-
-```js
-module.exports = {
-  ...
-  extends: [
-    ...
-    "@some-scope/eslint-config",
-  ],
-  ...
-}
-```
-
-The package containing your shareable configuration should be added as a dependency by running `yarn add your-package`.
-
-### Adding a plugin
-
-Adding a plugin is quite simple, you just have to modify `index.js` and add your plugin to the `plugins` array:
-
-```js
-module.exports = {
-  ...
-  plugins: [
-    ...
-    "your-plugin",
-  ],
-  ...
-}
-```
-
-The package containing your plugin should be added as a [peer dependency](https://classic.yarnpkg.com/en/docs/dependency-types/) by running `yarn add --peer your-plugin`.
+If you find a useful rule that you feel every project at BAM should use, feel free to contribute, [here is a link](./CONTRIBUTING.md) where you'll find explanations on how to do so.