Skip to content

Commit c993e07

Browse files
authored
docs: add CONTRIBUTING.md (#1617)
1 parent 4a2b448 commit c993e07

File tree

2 files changed

+41
-6
lines changed

2 files changed

+41
-6
lines changed

CONTRIBUTING.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# How to contribute
2+
3+
## Requirements
4+
5+
[Node.js](https://nodejs.org/) >= 14, [PNPM](https://pnpm.io/) >= 7, [Rust](https://www.rust-lang.org/)
6+
7+
After Rust is installed, add `wasm32-wasi`.
8+
9+
```shell
10+
rustup target add wasm32-wasi
11+
```
12+
13+
## Setup the repository locally
14+
15+
1. Fork and clone the repository.
16+
17+
```shell
18+
git clone https://github.com/<your name>/dumi.git
19+
cd dumi
20+
```
21+
22+
2. Install all dependencies
23+
24+
```shell
25+
pnpm install
26+
```
27+
28+
> 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.
29+
30+
Now you can start developing
31+
32+
```shell
33+
pnpm dev
34+
pnpm docs:dev
35+
```
36+
37+
## Submitting the Pull Request
38+
39+
Submit a pull request from your topic branch to the master branch on the umijs/dumi repository.

README.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,9 @@ dumi is a static site generator for component library development.
1010

1111
To view more online examples and docs, please visit [dumi official site](https://d.umijs.org).
1212

13-
## Development
13+
## Contributing
1414

15-
```bash
16-
$ pnpm install
17-
$ pnpm dev
18-
$ pnpm docs:dev
19-
```
15+
See [CONTRIBUTING.md](CONTRIBUTING.md)
2016

2117
## Badge
2218

0 commit comments

Comments
 (0)