diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 088c0ac33c..82997ea8bf 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,39 +1,40 @@ -# Pull Request Template +# Pull Request -⚠️ Before Submitting a PR, Please Review: -- Please ensure that you have thoroughly read and understood the [Contributing Docs](https://github.com/danny-avila/LibreChat/blob/main/.github/CONTRIBUTING.md) before submitting your Pull Request. - -⚠️ Documentation Updates Notice: -- Kindly note that documentation updates are managed in this repository: [librechat.ai](https://github.com/LibreChat-AI/librechat.ai) +> Before submitting, please review the [Contributing Guide](https://github.com/danny-avila/LibreChat/blob/main/.github/CONTRIBUTING.md). +> +> Documentation changes belong in the [LibreChat documentation repository](https://github.com/LibreChat-AI/librechat.ai). ## Summary ## How it works -## Change Type +## Type of change -Please delete any irrelevant options. + -- [ ] 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 -- [ ] Translation update +* [ ] Bug fix +* [ ] Feature +* [ ] Refactor +* [ ] Performance improvement +* [ ] Breaking change +* [ ] Documentation +* [ ] Translation +* [ ] Tests / tooling / CI ## Testing -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. + + +**Tested environments/configuration:** + + + +**Automated tests:** + + + +## Screenshots / recordings + + + +## Risk / compatibility + + ## Checklist -Please delete any irrelevant options. - -- [ ] My code adheres to this project's style guidelines -- [ ] I have performed a self-review of my own code -- [ ] I have commented in any complex areas of my code -- [ ] I have made pertinent documentation changes -- [ ] My changes do not introduce new warnings -- [ ] I have written tests demonstrating that my changes are effective or that my feature works -- [ ] Local unit tests pass with my changes -- [ ] Any changes dependent on mine have been merged and published in downstream modules. -- [ ] A pull request for updating the documentation has been submitted. +* [ ] I reviewed my own changes +* [ ] Relevant tests have been added or updated +* [ ] Existing relevant tests pass +* [ ] The change does not introduce new warnings or errors +* [ ] User-facing or complex behavior is documented where necessary +* [ ] Required dependency changes have been merged/published +* [ ] Required documentation PR: