Skip to content

Commit 64a2128

Browse files
committed
docs: remove outdated information from CONTRIBUTING.md
1 parent 3900a23 commit 64a2128

File tree

1 file changed

+2
-25
lines changed

1 file changed

+2
-25
lines changed

.github/CONTRIBUTING.md

Lines changed: 2 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ Before submitting your contribution though, please make sure to take a moment an
1515
- [Building the documentation locally](#building-the-documentation-locally)
1616

1717
> [!NOTE]\
18-
> FYI: The ESLint Raect project is not a fork of the `jsx-eslint/eslint-plugin-react` project and meanwhile `jsx-eslint/eslint-plugin-react` is not the upstream of ESLint React.\
19-
> Therefore, the rules and features you see in `jsx-eslint/eslint-plugin-react` may not necessarily appear in ESLint React and its plugins.
18+
> FYI: The ESLint Raect project is not a fork of the `eslint-plugin-react` project and meanwhile `eslint-plugin-react` is not the upstream of ESLint React.\
19+
> Therefore, the rules and features you see in `eslint-plugin-react` may not necessarily appear in ESLint React and its plugins.
2020
2121
## Issue Reporting Guidelines
2222

@@ -70,26 +70,3 @@ Before submitting your contribution though, please make sure to take a moment an
7070
- `packages/core`: Utility module for static analysis of React core APIs and Patterns.
7171
- `packages/shared`: Shared constants, types and functions.
7272
- `website`: The documentation website for ESLint React.
73-
74-
### Developing Documentation
75-
76-
- The public documentation is written in MarkdownReact (MDX) and is located in the `website/pages/docs` folder.
77-
- Internal packages are documented using [TypeDoc](https://typedoc.org). You can find the documentation for each package in the `docs` folder of the package.
78-
79-
### Developing Rules
80-
81-
- The changes you are making to the rules are following the [Rule introduction or modification principles](../README.md#Philosophy#Rule-introduction-or-modification-principles).
82-
83-
- TODO: Add more info here
84-
85-
### Developing Core and Related Components
86-
87-
- TODO: Add more info here
88-
89-
#### Building the documentation locally
90-
91-
You can build the TypeDoc documentation locally running the following script:
92-
93-
```bash
94-
pnpm run build:docs
95-
```

0 commit comments

Comments
 (0)