a6eebb940f
* feat: improve code * feat: update docs * feat: update docs * Update index.md * Update features.md * Update when.md * Update contributing.md * Update translations.md * feat: clean up * Add files via upload * Update the-first-app.md * Update plugins.md * Update a-b-c.md * Update blocks.md * feat: update docs * Add files via upload * Update charts.md * feat: update navs * Update index.md * Update index.md * Update features.md * Update index.md * Update docker-compose.md * Update create-nocobase-app.md * Update git-clone.md * Update contributing.md * Update translations.md * Update plugins.md * Update the-first-app.md * Add files via upload * Update charts.md * Update charts.md * Update a-b-c.md * Update collections.md * Update menus.md * Update menus.md Co-authored-by: Zhou <zhou.working@gmail.com>
49 lines
818 B
Markdown
49 lines
818 B
Markdown
# Contributing
|
|
|
|
- Fork the source code to your own repository
|
|
- Modify source code
|
|
- Submit pull request
|
|
- Sign the CLA
|
|
|
|
## Download
|
|
|
|
```bash
|
|
# Replace the following git address with your own repo
|
|
git clone https://github.com/nocobase/nocobase.git
|
|
cd nocobase
|
|
yarn install
|
|
```
|
|
|
|
## Development and Testing
|
|
|
|
```bash
|
|
# Install and start the application
|
|
yarn dev
|
|
# Run all tests
|
|
yarn test
|
|
# Run all test files in the folder
|
|
yarn test <dir>
|
|
# Run a single test file
|
|
yarn test <file>
|
|
```
|
|
|
|
## Documentation preview
|
|
|
|
```bash
|
|
# Start documentation
|
|
yarn doc --lang=zh-CN
|
|
yarn doc --lang=en-US
|
|
```
|
|
|
|
The documentation is in the docs directory and follows Markdown syntax
|
|
|
|
```bash
|
|
|- /docs/
|
|
|- en-US
|
|
|- zh-CN
|
|
```
|
|
|
|
## Others
|
|
|
|
For more CLI instructions, please [refer to the NocoBase CLI chapter](./development/nocobase-cli.md)
|