зеркало из https://github.com/nextcloud/cookbook.git
Added and fix some documentation
Signed-off-by: Christian Wolf <github@christianwolf.email>
This commit is contained in:
Родитель
e356ca325d
Коммит
33cf2a2d2f
|
@ -2,17 +2,4 @@
|
|||
|
||||
We are happily accepting code contributions of different types. Here are some hints on this.
|
||||
|
||||
## Development environment
|
||||
|
||||
For now, there is no included documentation on how to setup your environment best.
|
||||
|
||||
You might however have alook at [this repository](https://github.com/christianlupus/nextcloud-docker-debug).
|
||||
It describes **one** way to get a running development environment for the app.
|
||||
|
||||
## Unit tests and code coverage
|
||||
|
||||
Currently there is a github action in place that does automatic unit testing upon pushing to github.
|
||||
These tests are generating code coverage reports as well.
|
||||
|
||||
Firstly, for each such run (see in the actions view or the PR tests) there is the option to download the code coverage as zipped HTML page.
|
||||
Secondly, the [codecov.io service](https://codecov.io/gh/nextcloud/cookbook) is installed, where more details about the coverage can be found.
|
||||
Please have a look at the [developer documentation](https://nextcloud.github.io/cookbook/dev/) in general and about [contributing](https://nextcloud.github.io/cookbook/dev/contributing/).
|
||||
|
|
|
@ -0,0 +1,7 @@
|
|||
## Unit tests and code coverage
|
||||
|
||||
Currently there is a github action in place that does automatic unit testing upon pushing to github.
|
||||
These tests are generating code coverage reports as well.
|
||||
|
||||
Firstly, for each such run (see in the actions view or the PR tests) there is the option to download the code coverage as zipped HTML page.
|
||||
Secondly, the [codecov.io service](https://codecov.io/gh/nextcloud/cookbook) is installed, where more details about the coverage can be found.
|
|
@ -9,7 +9,12 @@ If you need additional information or find any missing parts, feel free to conta
|
|||
## Coding
|
||||
The first step, when you want to help with coding on the app, will be to setup your development environment.
|
||||
We prepared a [page on the setup](setup) to help you get started with the technical requirements.
|
||||
See also the page on [code coverage](code_coverage).
|
||||
|
||||
## Translating
|
||||
Feel free to have a look at the [transifex page on the cookbook app](https://www.transifex.com/nextcloud/nextcloud/cookbook/).
|
||||
Any translations done there will be synchronized on a nightly base.
|
||||
|
||||
## Documentation
|
||||
We also need helpers in writing documentation for various levels and user groups.
|
||||
If you think you can help by writing appropriate documentation or tutorials, feel free to step forward.
|
||||
|
|
|
@ -59,11 +59,9 @@ The frontend is based on Vue. Some Javascript/NPM dependencies are needed in ord
|
|||
|
||||
Open a terminal to the directory where you cloned the cookbook app. Then download the dependencies with:
|
||||
```
|
||||
npm install
|
||||
npm ci
|
||||
```
|
||||
|
||||
To reset you can remove the folder `node_modules` and the file `package-lock.json`. Then you can install all packages from scratch.
|
||||
|
||||
## Create the bundled assets for the frontend
|
||||
|
||||
Use the NPM script to prepare the Webpack bundle:
|
||||
|
|
Загрузка…
Ссылка в новой задаче