Andreas/LibreChat
1
0
Fork 0
mirror of https://github.com/danny-avila/LibreChat.git synced 2026-01-06 10:38:50 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

🧑‍💻docs: Update General Docs and Contribution Guidelines (#2194)

Browse source 
* doc upddate: documentation_guidelines.md

* doc upddate: how_to_contribute.md

* doc upddate: testing.md / how_to_contribute.md

* doc upddate: translation_contribution.md/testing.md/how_to_contribute.md

* doc upddate: coding_conventions.md

* fix formatting: how_to_contribute.md

* fix formatting (again) : how_to_contribute.md
This commit is contained in:
Fuegovic 2024-03-25 07:26:43 -04:00 • committed by GitHub
parent f86d80de59
commit a4f4ec85f8
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
7 changed files with 283 additions and 106 deletions
Download patch file Download diff file Expand all files Collapse all files

21
docs/contributions/testing.md
View file

@ -6,7 +6,24 @@ weight: -6
# Locally test the app during development
## WIP
## Local Unit Tests
Before submitting your updates, it’s crucial to verify they pass all unit tests. Follow these steps to run tests locally:
- copy your `.env.example` file in the `/api` folder and rename it to `.env`
```bash
cp .env.example ./api/.env
```
- add `NODE_ENV=CI` to your `/api/.env` file
- `npm run test:client`
- `npm run test:api`
!!! failure "Warning"
When executed locally, this API unit test is expected to fail. This should be the only error encountered.
![image](https://github.com/danny-avila/LibreChat/assets/32828263/d222034c-9c3a-4764-b972-39e954c92170)
<!-- ## WIP
## Run the tests
@ -25,6 +42,6 @@ weight: -6
If everything goes well, you should see a `passed` message.
![testing-1](https://github.com/danny-avila/LibreChat/assets/32828263/35b5c6a8-5c76-4e76-8ad9-2b1977eabc2a)
![testing-1](https://github.com/danny-avila/LibreChat/assets/32828263/35b5c6a8-5c76-4e76-8ad9-2b1977eabc2a) -->