Skip to content

Commit 669a8af

Browse files
committed
docs: enhance contributing guidelines and FAQ with package details
1 parent eda507c commit 669a8af

File tree

2 files changed

+53
-17
lines changed

2 files changed

+53
-17
lines changed

.github/CONTRIBUTING.md

Lines changed: 29 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,12 @@ Before submitting your contribution though, please make sure to take a moment an
1313
- [Pull Request Guidelines](#pull-request-guidelines)
1414
- [Development Guide](#development-guide)
1515
- [Packages Overview](#packages-overview)
16+
- [Internal Packages](#internal-packages)
17+
- [Utility Modules](#utility-modules)
18+
- [Core & Shared Modules](#core--shared-modules)
19+
- [Public Packages](#public-packages)
20+
- [ESLint Plugins](#eslint-plugins)
21+
- [Website & Playground](#website--playground)
1622

1723
## Issue Reporting Guidelines
1824

@@ -52,19 +58,33 @@ Before submitting your contribution though, please make sure to take a moment an
5258

5359
### Packages Overview
5460

55-
- `packages/plugins/eslint-plugin-react-x`: ESLint plugin for `"react"`.
56-
- `packages/plugins/eslint-plugin-react-dom`: ESLint plugin for `"react-dom"`.
57-
- `packages/plugins/eslint-plugin-react-web-api` - ESLint plugin for interacting with Web APIs.
58-
- `packages/plugins/eslint-plugin-react-hooks-extra`: ESLint plugin for React Hooks related rules.
59-
- `packages/plugins/eslint-plugin-react-naming-convention`: ESLint plugin for React naming conventions.
60-
- `packages/plugins/eslint-plugin-react-debug`: ESLint plugin for debugging ESLint React rules.
61-
- `packages/plugins/eslint-plugin`: The main ESLint plugin of ESLint React. Contains all the rules from the above plugins.
61+
#### Internal Packages
62+
63+
##### Utility Modules
64+
6265
- `packages/utilities/eff`: JavaScript and TypeScript utilities (previously some re-exports of the `effect` library).
6366
- `packages/utilities/ast`: TSESTree AST utility module.
6467
- `packages/utilities/var`: TSESTree AST utility module for static analysis of variables.
6568
- `packages/utilities/jsx`: TSESTree AST utility module for static analysis of JSX.
69+
70+
##### Core & Shared Modules
71+
6672
- `packages/core`: Utility module for static analysis of React core APIs and Patterns.
6773
- `packages/shared`: Shared constants, types and functions.
68-
- `apps/website`: The documentation website for ESLint React.
6974

70-
<!-- - `apps/playground`: The playground for ESLint React. -->
75+
#### Public Packages
76+
77+
##### ESLint Plugins
78+
79+
- `packages/plugins/eslint-plugin-react-x`: ESLint plugin for `"react"`.
80+
- `packages/plugins/eslint-plugin-react-dom`: ESLint plugin for `"react-dom"`.
81+
- `packages/plugins/eslint-plugin-react-web-api` - ESLint plugin for interacting with Web APIs.
82+
- `packages/plugins/eslint-plugin-react-hooks-extra`: ESLint plugin for React Hooks related rules.
83+
- `packages/plugins/eslint-plugin-react-naming-convention`: ESLint plugin for React naming conventions.
84+
- `packages/plugins/eslint-plugin-react-debug`: ESLint plugin for debugging ESLint React rules.
85+
- `packages/plugins/eslint-plugin`: The main ESLint plugin of ESLint React. Contains all the rules and config presets from the above plugins.
86+
87+
#### Website & Playground
88+
89+
- `apps/website`: The documentation website for ESLint React.
90+
- `apps/playground`: The playground for ESLint React (WIP).

apps/website/content/docs/faq.mdx

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,30 @@ Just as in [Beyond the DOM](https://legacy.reactjs.org/docs/design-principles.ht
2020

2121
<Accordion title="What is included in eslint-react?">
2222

23-
Currently, it includes the following plugins:
24-
25-
- `@eslint-react/eslint-plugin` - The main ESLint plugin package including all rules and config presets in this repository.
26-
- `eslint-plugin-react-x` - Core rules (renderer-agnostic, compatible with x-platform).
27-
- `eslint-plugin-react-dom` - DOM specific rules for React DOM.
28-
- `eslint-plugin-react-web-api` - Rules for interacting with Web APIs.
29-
- `eslint-plugin-react-hooks-extra` - Extra React Hooks rules.
30-
- `eslint-plugin-react-naming-convention` - Naming convention rules.
23+
Currently, it includes the following:
24+
25+
**Internal Packages**
26+
- **Utility Modules**
27+
- `packages/utilities/eff`: JavaScript and TypeScript utilities (previously some re-exports of the `effect` library).
28+
- `packages/utilities/ast`: TSESTree AST utility module.
29+
- `packages/utilities/var`: TSESTree AST utility module for static analysis of variables.
30+
- `packages/utilities/jsx`: TSESTree AST utility module for static analysis of JSX.
31+
- **Core & Shared Modules**
32+
- `packages/core`: Utility module for static analysis of React core APIs and Patterns.
33+
- `packages/shared`: Shared constants, types and functions.
34+
35+
**Public Packages**
36+
- **ESLint Plugins**
37+
- [`eslint-plugin-react-x`](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) - Core rules (renderer-agnostic, compatible with x-platform).
38+
- [`eslint-plugin-react-dom`](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) - DOM specific rules for React DOM.
39+
- [`eslint-plugin-react-web-api`](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-web-api) - Rules for interacting with Web APIs.
40+
- [`eslint-plugin-react-hooks-extra`](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-hooks-extra) - Extra React Hooks rules.
41+
- [`eslint-plugin-react-naming-convention`](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-naming-convention) - Naming convention rules.
42+
- [`@eslint-react/eslint-plugin`](https://www.npmjs.com/package/@eslint-react/eslint-plugin) - All rules and config presets from the above plugins.
43+
44+
**Website & Playground**
45+
- `website`: This documentation website.
46+
- `playground`: The playground for ESLint React (WIP).
3147

3248
You can view our long-term plans on the [roadmap](/roadmap#plugins-with-ecological-niche-explanation).
3349

0 commit comments

Comments
 (0)