mirror of
https://github.com/danny-avila/LibreChat.git
synced 2026-01-09 03:58:51 +01:00
docs : update the documentation (#345)
* Add files via upload * Delete documents/report_templates directory * Update PR-TEMPLATE.md * Update README.md removed templates from TOC * Update SECURITY.md - update to follow documentation guidelines - update discord link to point to issues * Update SECURITY.md * Update README.md add security to TOC * Delete pull_request_template.md moved to .github * Rename PR-TEMPLATE.md to PULL-REQUEST.md * Update mac_install.md clean up and update * Update windows_install.md fix formating and change update instructions * Update windows_install.md add docker recommendation * Update windows_install.md * Update mac_install.md
This commit is contained in:
parent
5964b71e14
commit
8d4ef16b7f
9 changed files with 138 additions and 162 deletions
35
.github/PULL_REQUEST_TEMPLATE/PULL-REQUEST.md
vendored
Normal file
35
.github/PULL_REQUEST_TEMPLATE/PULL-REQUEST.md
vendored
Normal file
|
|
@ -0,0 +1,35 @@
|
|||
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.
|
||||
|
||||
|
||||
|
||||
## Type of change
|
||||
|
||||
Please delete options that are not relevant.
|
||||
|
||||
- [ ] Bug fix (non-breaking change which fixes an issue)
|
||||
- [ ] New feature (non-breaking change which adds functionality)
|
||||
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
|
||||
- [ ] This change requires a documentation update
|
||||
|
||||
|
||||
|
||||
## How Has This Been Tested?
|
||||
|
||||
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**:
|
||||
##
|
||||
|
||||
|
||||
## Checklist:
|
||||
|
||||
- [ ] My code follows the style guidelines of this project
|
||||
- [ ] I have performed a self-review of my code
|
||||
- [ ] I have commented my code, particularly in hard-to-understand areas
|
||||
- [ ] I have made corresponding changes to the documentation
|
||||
- [ ] My changes generate no new warnings
|
||||
- [ ] I have added tests that prove my fix is effective or that my feature works
|
||||
- [ ] 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