Skip to content

Commit

Permalink
chore: add CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
JuniorTour committed Aug 22, 2021
1 parent 9dec70b commit c05e958
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 1 deletion.
22 changes: 22 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Getting Started
## 1. Find or create a issue to discuss

## 2. Fork and git clone this repo to your dev env

``` shell script
git clone https://github.com/JuniorTour/vue-template-babel-compiler.git
```

## 3. Use [npm run debugTest](https://github.com/JuniorTour/vue-template-babel-compiler/blob/main/package.json#L18) to help you locate the issue

```shell script
npm run debugTest
# or
yarn debugTest
```

## 4. Push your changes to create Pull Request for this repo

## 5. Wait for review~

## Feel free to ask anything
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"scripts": {
"build": "rollup -c rollup.config.js",
"test": " npm run build && jest",
"inspect": "npm run build && node --inspect-brk ./node_modules/jest/bin/jest.js --runInBand",
"debugTest": "npm run build && node --inspect-brk ./node_modules/jest/bin/jest.js --runInBand",
"prepublishOnly": "jest && npm run build"
},
"jest": {
Expand Down

0 comments on commit c05e958

Please sign in to comment.