doc: add development setup guide

HerringtonDarkholme · HerringtonDarkholme · commit 99338d01d247 · 2023-08-02T00:40:41.000-07:00
fix ast-grep#157
diff --git a/website/.vitepress/config.ts b/website/.vitepress/config.ts
@@ -91,6 +91,7 @@ export default defineConfig({
         text: 'Contributing',
         items: [
           { text: 'Guide', link: '/contributing/how-to.html' },
+          { text: 'Development', link: '/contributing/development.html' },
         ],
         collapsed: true,
       },
diff --git a/website/contributing/development.md b/website/contributing/development.md
@@ -0,0 +1,74 @@
+# Development Guide
+
+## Environment Setup
+
+
+ast-grep is written in [Rust](https://www.rust-lang.org/) and hosted by [git](https://git-scm.com/).
+
+You need to have rust environment installed to build ast-grep.
+The recommended way to install rust is via [rustup](https://rustup.rs/).
+Once you have rustup installed, you can install rust by running:
+
+```bash
+rustup install stable
+```
+
+You also need  [pre-commit](https://pre-commit.com/) to setup git hooks for type checking, formatting and clippy.
+
+Run pre-commit install to set up the git hook scripts.
+
+```bash
+pre-commit install
+```
+
+Optionally, you can also install [nodejs](https://github.com/Schniz/fnm) and [yarn](https://yarnpkg.com/) for napi binding development.
+
+That's it! You have setup the environment for ast-grep!
+
+## Common Commands
+
+The below are some cargo commands common to any Rust project.
+
+```bash
+cargo test     # Run test
+cargo check    # Run checking
+cargo clippy   # Run clippy
+cargo fmt      # Run formatting
+```
+
+
+Below are some ast-grep specific commands.
+
+## N-API Development
+
+[@ast-grep/napi](https://www.npmjs.com/package/@ast-grep/napi) is the [nodejs binding](https://napi.rs/) for ast-grep.
+
+The source code of napi binding is under the `crates/napi` folder. You can refer to the [package.json](https://github.com/ast-grep/ast-grep/blob/main/crates/napi/package.json) for available commands.
+
+```bash
+cd crates/napi
+yarn   # Install dependencies
+yarn build # Build the binding
+yarn test # Run test
+```
+
+## Run Benchmark
+ast-grep's Benchmark is not included in the default cargo test. You need to run the benchmark command in `benches` folder.
+
+```bash
+cd benches
+cargo bench
+```
+
+ast-grep's benchmarking suite is not well developed yet. The result may fluctuate too much.
+
+## Release New Version
+
+The command below will bump version and create a git tag for ast-grep.
+Once pushed to GitHub, the tag will trigger [GitHub actions](https://github.com/ast-grep/ast-grep/blob/main/.github/workflows/coverage.yml) to build and publish the new version to [crates.io](https://github.com/ast-grep/ast-grep/blob/main/.github/workflows/pypi.yml), [npm](https://github.com/ast-grep/ast-grep/blob/main/.github/workflows/napi.yml) and [PyPi](https://github.com/ast-grep/ast-grep/blob/main/.github/workflows/pypi.yml).
+
+```bash
+cargo xtask [version-number]
+```
+
+See [xtask](https://github.com/ast-grep/ast-grep/blob/main/xtask/src/main.rs) file for more details.
diff --git a/website/contributing/how-to.md b/website/contributing/how-to.md
@@ -19,7 +19,7 @@ We appreciate your feedback on the project. Whether you have a feature request,
 
 We welcome your code contributions to the project. Whether you want to fix a bug, implement a feature, improve the documentation, or add a new integration, we are grateful for your help. You can use the following repositories to contribute your code:
 
-- **CLI Main Repo**: The [main repository for ast-grep](https://github.com/ast-grep/ast-grep) command-line interface (CLI). It contains the core logic and functionality of ast-grep. For small features or typo fixes, you can fork this repository and submit pull requests with your changes. _For larger features or big changes, please make an issue for discussion before jumping into it._
+- **CLI Main Repo**: The [main repository for ast-grep](https://github.com/ast-grep/ast-grep) command-line interface (CLI). It contains the core logic and functionality of ast-grep. For small features or typo fixes, you can fork this repository and submit pull requests with your changes. [This guide](/contributing/development.html) may help you set up essential tools for development. _For larger features or big changes, please make an issue for discussion before jumping into it._
 
 <!-- Please follow the [code style guide] and the [testing guide] before submitting your pull requests. -->
 
diff --git a/website/contributing/setup.md b/website/contributing/setup.md
