Skip to content

Commit 9288cf7

Browse files
azyzz228ljharb
authored andcommitted
[meta] CONTRIBUTING.md: add resources for newcomers
1 parent c2f003a commit 9288cf7

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

CONTRIBUTING.md

+9
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,15 @@ When opening an [issue](#issues):
1818

1919
Remember, you don't need to do it all yourself; any of these are helpful! 😎
2020

21+
## How to get started
22+
23+
If you are new to `eslint`, below are a few resources that will help you to familiarize yourself with the project.
24+
25+
- Watch [this presentation](https://www.youtube.com/watch?v=2W9tUnALrLg) to learn the fundamental concept of Abstract Syntax Trees (AST) and the way `eslint` works under the hood.
26+
- Familiarize yourself with the [AST explorer](https://astexplorer.net/) tool. Look into rules in `docs/rules`, create patterns in the rules, then analyze its AST.
27+
- Explore the blog posts on how to create a custom rule. [One blog post](https://blog.yonatan.dev/writing-a-custom-eslint-rule-to-spot-undeclared-props/). [Second blog post](https://betterprogramming.pub/creating-custom-eslint-rules-cdc579694608).
28+
- Read the official `eslint` [developer guide](https://eslint.org/docs/latest/developer-guide/architecture/).
29+
2130
## Issues
2231

2332
### Search open + closed issues for similar cases

0 commit comments

Comments
 (0)