Skip to content

Commit

Permalink
docs: add CONTRIBUTING.md (umijs#1617)
Browse files Browse the repository at this point in the history
  • Loading branch information
jeffwcx authored Apr 18, 2023
1 parent 4a2b448 commit c993e07
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 6 deletions.
39 changes: 39 additions & 0 deletions CONTRIBUTING.md
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.
8 changes: 2 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,9 @@ dumi is a static site generator for component library development.

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

## Development
## Contributing

```bash
$ pnpm install
$ pnpm dev
$ pnpm docs:dev
```
See [CONTRIBUTING.md](CONTRIBUTING.md)

## Badge

Expand Down

0 comments on commit c993e07

Please sign in to comment.