mirror of
https://github.com/danny-avila/LibreChat.git
synced 2025-12-18 09:20:15 +01:00
chore: Update pull_request_template.md
This commit is contained in:
parent
68ad46a9be
commit
cb3cf9b33e
1 changed files with 33 additions and 20 deletions
51
.github/pull_request_template.md
vendored
51
.github/pull_request_template.md
vendored
|
|
@ -1,10 +1,28 @@
|
||||||
Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.
|
# Pull Request Template
|
||||||
|
|
||||||
|
|
||||||
|
### ⚠️ Pre-Submission Steps:
|
||||||
|
|
||||||
## Type of change
|
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`)
|
||||||
|
|
||||||
Please delete options that are not relevant.
|
## Summary
|
||||||
|
|
||||||
|
Please provide a brief summary of your changes and the related issue. Include any motivation and context that is relevant to your changes. If there are any dependencies necessary for your changes, please list them here.
|
||||||
|
|
||||||
|
## Change Type
|
||||||
|
|
||||||
|
Please delete any irrelevant options.
|
||||||
|
|
||||||
- [ ] Bug fix (non-breaking change which fixes an issue)
|
- [ ] Bug fix (non-breaking change which fixes an issue)
|
||||||
- [ ] New feature (non-breaking change which adds functionality)
|
- [ ] New feature (non-breaking change which adds functionality)
|
||||||
|
|
@ -12,24 +30,19 @@ Please delete options that are not relevant.
|
||||||
- [ ] This change requires a documentation update
|
- [ ] This change requires a documentation update
|
||||||
- [ ] Documentation update
|
- [ ] Documentation update
|
||||||
|
|
||||||
|
## Testing
|
||||||
|
|
||||||
## How Has This Been Tested?
|
Please describe your test process and include instructions so that we can reproduce your test. If there are any important variables for your testing configuration, list them here.
|
||||||
|
|
||||||
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration:
|
|
||||||
##
|
|
||||||
|
|
||||||
|
|
||||||
### **Test Configuration**:
|
### **Test Configuration**:
|
||||||
##
|
|
||||||
|
|
||||||
|
## Checklist
|
||||||
|
|
||||||
## Checklist:
|
- [ ] My code adheres to this project's style guidelines
|
||||||
|
- [ ] I have performed a self-review of my own code
|
||||||
- [ ] My code follows the style guidelines of this project
|
- [ ] I have commented in any complex areas of my code
|
||||||
- [ ] I have performed a self-review of my code
|
- [ ] I have made pertinent documentation changes
|
||||||
- [ ] I have commented my code, particularly in hard-to-understand areas
|
- [ ] My changes do not introduce new warnings
|
||||||
- [ ] I have made corresponding changes to the documentation
|
- [ ] I have written tests demonstrating that my changes are effective or that my feature works
|
||||||
- [ ] My changes generate no new warnings
|
- [ ] Local unit tests pass with my changes
|
||||||
- [ ] I have added tests that prove my fix is effective or that my feature works
|
- [ ] Any changes dependent on mine have been merged and published in downstream modules.
|
||||||
- [ ] New and existing unit tests pass locally with my changes
|
|
||||||
- [ ] Any dependent changes have been merged and published in downstream modules
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue