File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1+ # Regex Vis Contribution Guide
2+
3+ ## Ask questions
4+
5+ You can open a new [ discussion] ( https://github.com/Bowen7/regex-vis/discussions ) to ask questions about this repository or get help.
6+
7+ ## Report a bug
8+
9+ Please first search the repository's [ Issues] ( https://github.com/Bowen7/regex-vis/issues ) page and make sure that no one has already reported it.
10+
11+ If it hasn't been reported, please feel free to submit an issue.
12+
13+ ## Open a PR
14+
15+ Preparation:
16+
17+ 1 . ` pnpm ` . ` regex-vis ` use ` pnpm ` as the package manager, so make sure to install it globally.
18+ 2 . Node.js v16.x You can choose a Node.js version manager to easily switch between different Node.js versions easily.
19+
20+ Steps:
21+
22+ 1 . Fork this project to your own account.
23+ 2 . Checkout to a new branch.
24+ 3 . Run ` pnpm install ` to install dependencies.
25+ 4 . Run ` pnpm start ` to start a development server on the 3000 port.
26+ 5 . Edit code.
27+ 6 . Run ` pnpm test ` . Make sure to pass all test cases.
28+ 7 . Submit your code.
29+ 8 . [ Open a PR on Github] ( https://github.com/Bowen7/regex-vis/compare ) .
30+
31+ ## FAQ
32+
33+ Q: Can I use Chinese as the language of communication?
34+
35+ A: Yes, but using English is a better choice to make it possible for more people to understand and participate in the conversation.
Original file line number Diff line number Diff line change 66
77
88## Features
9- - Regular expression visualizer
10- - Visual editing regular expression
11- - Testing regular expression
9+ - Visualizing regular expressions
10+ - Visual editing of regular expressions
11+ - Testing of regular expressions.
1212
1313## Blog
1414- [ English] ( https://www.bowencodes.com/post/regex-vis_en )
1515- [ Chinese] ( https://www.bowencodes.com/post/regex-vis )
1616
17- ## Deployment
17+ ## Contribution Guide
1818
19- To deploy this project run
20-
21- ``` bash
22- # install dependencies, use pnpm!
23- $ pnpm install
24-
25- # serve with hot reload at localhost:3000
26- $ pnpm start
27- ```
19+ [ Contribution Guide] ( https://github.com/Bowen7/regex-vis/blob/master/.github/CONTRIBUTING.md )
2820
2921## Feedback
3022
You can’t perform that action at this time.
0 commit comments