vbatts/llama.cpp
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc: Simplified PR template, referenced ggml-ci and test commands

Browse source
This commit is contained in:
Nicolas Perez 2024-06-03 20:29:23 -04:00
parent 8cc17410f5
commit 1064043e64
1 changed files with 8 additions and 32 deletions
Download patch file Download diff file Expand all files Collapse all files

40
.github/PULL_REQUEST_TEMPLATE/pull_request_template.md vendored
View file

@ -1,40 +1,16 @@
# Pull Request Template
## Summary
[Summarize your changes]
* [Briefly describe the changes made in this PR.]
* [Include any relevant context, such as the issue or feature being addressed.]
## Changes Made
* [List specific files or directories affected by these changes]
* [Describe any significant updates, rewrites, or new code added]
* [Mention any removed or deleted files or code]
## Relevant Details
* **Affected Code**: [List specific code paths, functions, or classes changed or updated]
* **Impact**: [Explain how the changes affect the project's functionality, performance, or security]
* **New Features/Changes**: [Describe new features or significant changes added in this PR]
* **Fixed Issues**: [List specific issues or bugs fixed by these changes]
## How would you rate the complexity of this PR? (Easy, Medium, Hard)
[Review complexity]
## Verification
To verify this PR, you can:
* Run automated tests or scripts to ensure the changes do not introduce errors
* Review code for style, security, and best practices
* Verify that all changed files are properly formatted and consistent
* Make sure that your PR follows the [contributing guidelines](CONTRIBUTING.md) and the [coding guidelines](https://github.com/ggerganov/llama.cpp/blob/master/README.md#coding-guidelines)
* Test your changes using the commands in the [`tests`](tests) folder
* For instance, running the `./tests/test-backend-ops` command tests different backend implementations of the GGML library
*
## Additional Information (Optional)
[Add any additional context, explanations, or requests that are relevant to this PR.]
**Important Notes**
* If this pull request only contains documentation changes (e.g., updating
READMEs, adding new wiki pages), please add `[no ci]` to the commit title.
This will skip unnecessary CI checks and help reduce build times.
* When squashing multiple commits on merge, use the following format for
your commit title: `<module>:<commit title> (#<issue_number>)`. For example: `utils: Fix typo in utils.py (#1234)`
* Please ensure that this PR follows our contributing guidelines, available at [](README.md). This includes formatting code according to our style guide and ensuring that all changes are thoroughly tested.
* Execute [the full CI locally on your machine](ci/README.md) before publishing