Skip to content

Commit 19358e3

Browse files
authored
Merge pull request #1907 from LibreSign/feature/improve-documentation
Update CONTRIBUTING.md
2 parents 5e0df86 + e49b4cb commit 19358e3

File tree

1 file changed

+37
-10
lines changed

1 file changed

+37
-10
lines changed

CONTRIBUTING.md

Lines changed: 37 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,54 @@
11
# How to contribute?
22

3-
Fork and pull request! 😃
3+
**Simple way**: Fork and pull request! 😃
44

5-
NOTE: If the project does not have an issue for what you want to do, create an issue first.
5+
**NOTE**: If the project does not have an issue for what you want to do, create an issue first.
66

77
Feel free to submit [Github Issues](https://github.com/libresign/libresign/issues) or pull requests.
88

9-
The documentation website is build from the docs folder with vuepress.
9+
But... follow the complete way:
1010

1111
## To start front and backend development environment
1212

13-
```bash
14-
make serve
15-
```
13+
* Start the Nextcloud development.
14+
> **NOTE**: I suggest to use this: https://github.com/LibreCodeCoop/nextcloud-docker-development/ only because is the environment that I use 😅. I also suggest to use https://github.com/juliushaertl/nextcloud-docker-dev but the setup will be a bit different of this tutorial.
15+
* Wait to be possible access `localhost` in your browser
16+
* Inside the folder of nextcloud environment (the folder that contains the project of previous step), go to `volumes/nextloud/apps-extra` clone the LibreSign repository
17+
* open bash in nextcloud container with `docker compose exec -u www-data nextcloud bash`
18+
* Inside bash of Nextcloud, go to folder `apps-extra/libresign`
19+
* Run the commands:
20+
```bash
21+
# download composer dependencies
22+
composer install
23+
# download JS dependencies
24+
npm ci
25+
# build and watch JS changes
26+
npm run watch
27+
```
28+
* Now, access the `localhost` on your browser
1629

1730
## To update API documentation
1831

1932
[Repository of site and API documentation](https://github.com/libresign/libresign.github.io)
2033

21-
## To run PHPUnit
34+
## Executing tests
35+
### PHPUnit, Psalm, PHPCS,...
2236

23-
```bash
24-
make test
25-
```
37+
* Run all tests inside `bash` of `nextcloud` service
2638

2739
Read more in composer.json scripts section
40+
41+
### Behat
42+
43+
* Access bash of `nextcloud` service
44+
* Go to folder `tests/integration` of Libresign app
45+
* Install dependencies:
46+
```bash
47+
composer i
48+
```
49+
* Run tests:
50+
```bash
51+
vendor/bin/behat
52+
```
53+
54+
You also can run a specific scenario

0 commit comments

Comments
 (0)