ayo/astro-reactive-form
ayo/astro-reactive-form
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore: update docs and commands for the docs website (#67)

Browse source
This commit is contained in:
Ayo Ayco 2022-10-07 15:58:05 +02:00 committed by GitHub
parent 4e2d1562e6
commit ef779de6d4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 12 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
CONTRIBUTING.md
View file

@ -60,12 +60,22 @@ npm i
npm start npm start
``` ```
5. Open the demo application on you browser. Browse to the address: 5. Open the demo application on you browser. Browse to the address
``` ```
https://localhost:3000 https://localhost:3000
``` ```
# The Documentation website
Want to update the documentation? We also maintain the documentation website in this repository. The source for this is found in the `docs` directory. You can also start the dev server for the docs website with the following command:
```
npm run docs
```
# Running the linter and tests # Running the linter and tests
Please run the linter and tests before creating a PR to avoid delays in PR reviews. Fix all linting errors or failing tests whey you run the following commands. Please run the linter and tests before creating a PR to avoid delays in PR reviews. Fix all linting errors or failing tests whey you run the following commands.

1
package.json
View file

@ -21,6 +21,7 @@
"build": "npm run build --workspaces --if-present", "build": "npm run build --workspaces --if-present",
"test:watch": "npm run test:watch --workspaces --if-present", "test:watch": "npm run test:watch --workspaces --if-present",
"dev": "npm run dev -w demo", "dev": "npm run dev -w demo",
"docs": "npm run dev -w docs",
"bump": "npm version patch -w", "bump": "npm version patch -w",
"bump-minor": "npm version minor -w", "bump-minor": "npm version minor -w",
"bump-major": "npm version major -w", "bump-major": "npm version major -w",