Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Added initial PR template with directions for doc only changes and squash merges [no ci] #7700

Merged
merged 11 commits into from
Jun 9, 2024
Merged
40 changes: 40 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Pull Request Template

## Summary

* [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]
nicolasperez19 marked this conversation as resolved.
Show resolved Hide resolved

## 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

nicolasperez19 marked this conversation as resolved.
Show resolved Hide resolved
## 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.
nicolasperez19 marked this conversation as resolved.
Show resolved Hide resolved
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1088,6 +1088,7 @@ docker run --gpus all -v /path/to/models:/models local/llama.cpp:server-cuda -m

- Contributors can open PRs
- Collaborators can push to branches in the `llama.cpp` repo and merge PRs into the `master` branch
- Collaborators should follow the PR template when adding a PR
- Collaborators will be invited based on contributions
- Any help with managing issues and PRs is very appreciated!
- Make sure to read this: [Inference at the edge](https://github.com/ggerganov/llama.cpp/discussions/205)
Expand Down