Andreas/LibreChat
1
0
Fork 0
mirror of https://github.com/danny-avila/LibreChat.git synced 2026-02-07 18:14:22 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

docs: update with more real details, fix linking

Browse source
This commit is contained in:
Danny Avila 2023-09-06 13:58:38 -04:00 • committed by Danny Avila
parent ea8003c58b
commit fcd6b8f3a9
6 changed files with 81 additions and 58 deletions
Download patch file Download diff file Expand all files Collapse all files

15
.github/pull_request_template.md vendored
View file

@ -1,20 +1,7 @@
# Pull Request Template
### ⚠️ Pre-Submission Steps:
1. Before starting work, make sure your main branch has the latest commits with `npm run update`
2. Run linting command to find errors: `npm run lint`. Alternatively, ensure husky pre-commit checks are functioning.
3. After your changes, reinstall packages in your current branch using `npm run reinstall` and ensure everything still works.
- Restart the ESLint server ("ESLint: Restart ESLint Server" in VS Code command bar) and your IDE after reinstalling or updating.
4. Clear web app localStorage and cookies before and after changes.
5. For frontend changes:
- Install typescript globally: `npm i -g typescript`.
- Compile typescript before and after changes to check for introduced errors: `tsc --noEmit`.
6. Run tests locally:
- Backend unit tests: `npm run test:api`
- Frontend unit tests: `npm run test:client`
- Integration tests: `npm run e2e` (requires playwright installed, `npx install playwright`)
### ⚠️ Before Submitting a PR, read the [Contributing Docs](./CONTRIBUTING.md) in full!
## Summary