-
-
Notifications
You must be signed in to change notification settings - Fork 285
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
40 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
# Regex Vis Contribution Guide | ||
|
||
## Ask questions | ||
|
||
You can open a new [discussion](https://github.com/Bowen7/regex-vis/discussions) to ask questions about this repository or get help. | ||
|
||
## Report a bug | ||
|
||
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. | ||
|
||
If it hasn't been reported, please feel free to submit an issue. | ||
|
||
## Open a PR | ||
|
||
Preparation: | ||
|
||
1. `pnpm`. `regex-vis` use `pnpm` as the package manager, so make sure to install it globally. | ||
2. Node.js v16.x You can choose a Node.js version manager to easily switch between different Node.js versions easily. | ||
|
||
Steps: | ||
|
||
1. Fork this project to your own account. | ||
2. Checkout to a new branch. | ||
3. Run `pnpm install` to install dependencies. | ||
4. Run `pnpm start` to start a development server on the 3000 port. | ||
5. Edit code. | ||
6. Run `pnpm test`. Make sure to pass all test cases. | ||
7. Submit your code. | ||
8. [Open a PR on Github](https://github.com/Bowen7/regex-vis/compare). | ||
|
||
## FAQ | ||
|
||
Q: Can I use Chinese as the language of communication? | ||
|
||
A: Yes, but using English is a better choice to make it possible for more people to understand and participate in the conversation. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
92b4e86
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Successfully deployed to the following URLs:
regex-vis – ./
regex-vis-git-master-bowen.vercel.app
regex-vis-bowen.vercel.app
regex-vis.com