Skip to content

Commit

Permalink
docs: add contribution guide (#73)
Browse files Browse the repository at this point in the history
  • Loading branch information
Bowen7 authored May 6, 2023
1 parent 697838f commit 92b4e86
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 13 deletions.
35 changes: 35 additions & 0 deletions .github/CONTRIBUTING.md
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.
18 changes: 5 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,17 @@


## Features
- Regular expression visualizer
- Visual editing regular expression
- Testing regular expression
- Visualizing regular expressions
- Visual editing of regular expressions
- Testing of regular expressions.

## Blog
- [English](https://www.bowencodes.com/post/regex-vis_en)
- [Chinese](https://www.bowencodes.com/post/regex-vis)

## Deployment
## Contribution Guide

To deploy this project run

```bash
# install dependencies, use pnpm!
$ pnpm install

# serve with hot reload at localhost:3000
$ pnpm start
```
[Contribution Guide](https://github.com/Bowen7/regex-vis/blob/master/.github/CONTRIBUTING.md)

## Feedback

Expand Down

1 comment on commit 92b4e86

@vercel
Copy link

@vercel vercel bot commented on 92b4e86 May 6, 2023

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

Please sign in to comment.