forked from umijs/dumi
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add CONTRIBUTING.md (umijs#1617)
- Loading branch information
Showing
2 changed files
with
41 additions
and
6 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,39 @@ | ||
# How to contribute | ||
|
||
## Requirements | ||
|
||
[Node.js](https://nodejs.org/) >= 14, [PNPM](https://pnpm.io/) >= 7, [Rust](https://www.rust-lang.org/) | ||
|
||
After Rust is installed, add `wasm32-wasi`. | ||
|
||
```shell | ||
rustup target add wasm32-wasi | ||
``` | ||
|
||
## Setup the repository locally | ||
|
||
1. Fork and clone the repository. | ||
|
||
```shell | ||
git clone https://github.com/<your name>/dumi.git | ||
cd dumi | ||
``` | ||
|
||
2. Install all dependencies | ||
|
||
```shell | ||
pnpm install | ||
``` | ||
|
||
> Due to the network download required by the scripts that need to be run during installation, you may need to set up a network proxy if an error occurs. | ||
Now you can start developing | ||
|
||
```shell | ||
pnpm dev | ||
pnpm docs:dev | ||
``` | ||
|
||
## Submitting the Pull Request | ||
|
||
Submit a pull request from your topic branch to the master branch on the umijs/dumi repository. |
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