You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: packages/eslint-plugin/CONTRIBUTING.md
+7-2Lines changed: 7 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,13 +7,13 @@ It is important to keep it up to date and to add new rules and configurations wh
7
7
8
8
If you feel that a rule could be useful to all react-native new projects, you can add it to the plugin by following these steps:
9
9
10
-
### Open an issue to discuss the rule with the community
10
+
### 1. Open an issue to discuss the rule with the community
11
11
12
12
- Go to this link : [RFC for a new rule on eslint-plugin ⭐](https://github.com/bamlab/react-native-project-config/issues/new?assignees=&labels=%F0%9F%93%8F+eslint-plugin%2C%E2%AD%90+enhancement&projects=&template=RFC-NEW-RULE.yml&title=%5BRFC%5D%3A+plugin%3Arule-name)
13
13
- Fill the template with any relevant information about the rule (why it is needed, how it works, shareable configs to add it to, etc.)
14
14
- Submit the issue and share it with the community
15
15
16
-
### After the discussion, if the rule is approved, you can create a PR to add the rule to the plugin
16
+
### 2. After the discussion, if the rule is approved, you can create a PR to add the rule to the plugin
17
17
18
18
- Create a new branch from `main` with the name `feat/plugin-rule-name`
19
19
- Go to the corresponding shareable config file (for example `recommended.js`) and add the rule to the `rules` object:
@@ -145,3 +145,8 @@ module.exports = {
145
145
```
146
146
147
147
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 eslint-plugin-some-plugin`.
148
+
149
+
## Release your changes on NPM
150
+
151
+
Once your PR has been merged, your changes will be added to the `main` branch of the project. However they won't be accessible for current plugin users, since the plugin is available through versionned npm packages.
152
+
If you need to release a newversionof the package including your changes, please follow this [Publishing a newversionof a package](https://github.com/bamlab/react-native-project-config/blob/main/README.md#publishing-a-new-version-of-a-package) section.
0 commit comments