From 522fe3b1e000b800b7d02d043cd4ecb1d4f36ee2 Mon Sep 17 00:00:00 2001 From: Nicolas Perez Date: Sun, 2 Jun 2024 16:05:06 -0400 Subject: [PATCH 01/11] doc: Added to README that collaborators should follow PR template --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 8680460aab700..f5ba2c786551f 100644 --- a/README.md +++ b/README.md @@ -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) From b449ca848dbf203c99fa856612e79976afa41511 Mon Sep 17 00:00:00 2001 From: Nicolas Perez Date: Sun, 2 Jun 2024 16:05:33 -0400 Subject: [PATCH 02/11] doc: Added general pull request template with directions for doc only changes and squash merges --- .../pull_request_template.md | 40 +++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE/pull_request_template.md diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md new file mode 100644 index 0000000000000..3c970783db865 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -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] + +## 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 + +## 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: `: (#)`. 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. From 6cf0a870950ddb44f0c022737c8516ef4a96e8d7 Mon Sep 17 00:00:00 2001 From: Nicolas Perez Date: Mon, 3 Jun 2024 20:23:38 -0400 Subject: [PATCH 03/11] doc: Moved contributing info from PR template to separate CONTRIBUTING file --- CONTRIBUTING.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000000..1e2818eaa3ed9 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,5 @@ +# Contributing Guidelines + +* If the 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: `: (#)`. For example: `utils: Fix typo in utils.py (#1234)` From 8cc17410f5072e456165557580a19b56c338ae9e Mon Sep 17 00:00:00 2001 From: Nicolas Perez Date: Mon, 3 Jun 2024 20:27:35 -0400 Subject: [PATCH 04/11] docs: Added link in README to pull request template --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f5ba2c786551f..981a795dd0213 100644 --- a/README.md +++ b/README.md @@ -1088,7 +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 should follow the [PR template](.github/PULL_REQUEST_TEMPLATE/pull_request_template.md) 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) From 1064043e6406a2a98917047309a3434e0ca62203 Mon Sep 17 00:00:00 2001 From: Nicolas Perez Date: Mon, 3 Jun 2024 20:29:23 -0400 Subject: [PATCH 05/11] doc: Simplified PR template, referenced ggml-ci and test commands --- .../pull_request_template.md | 40 ++++--------------- 1 file changed, 8 insertions(+), 32 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md index 3c970783db865..5f3853dd49c69 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -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 - -## Additional Information (Optional) - -[Add any additional context, explanations, or requests that are relevant to this PR.] - -**Important Notes** +* 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 + * -* 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: `: (#)`. 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 From 3de6557bdf12f872b9837f9ff12ccfaaa8acea2c Mon Sep 17 00:00:00 2001 From: Nicolas Perez Date: Tue, 4 Jun 2024 10:20:47 -0400 Subject: [PATCH 06/11] doc: Moved all PR template information to CONTRIBUTING.md --- CONTRIBUTING.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1e2818eaa3ed9..2e82f135d7a22 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,14 @@ # Contributing Guidelines +## Checklist + +* Make sure your PR follows 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 +* Execute [the full CI locally on your machine](ci/README.md) before publishing + +## PR formatting + +* Please rate the complexity of your PR (i.e. `easy`, `medium`, `hard`). This makes it easier for maintainers to triage the PRs. * If the 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: `: (#)`. For example: `utils: Fix typo in utils.py (#1234)` From e79bc7ef4d5881acd33ccec138082dfae65df579 Mon Sep 17 00:00:00 2001 From: Nicolas Perez Date: Tue, 4 Jun 2024 10:21:25 -0400 Subject: [PATCH 07/11] doc: Made PR template only contain a line that a collaborator has read the contributing guidelines --- .../pull_request_template.md | 17 +---------------- 1 file changed, 1 insertion(+), 16 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md index 5f3853dd49c69..278533b3429ec 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -1,16 +1 @@ -## Summary -[Summarize your changes] - -## How would you rate the complexity of this PR? (Easy, Medium, Hard) -[Review complexity] - -## Verification - -To verify this PR, you can: - -* 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 - * - -* Execute [the full CI locally on your machine](ci/README.md) before publishing +- [ ] I have read the [contributing guidelines](CONTRIBUTING.md) From dc8809d33c62715c2edb15ab4c5043dd81b3702a Mon Sep 17 00:00:00 2001 From: Brian Date: Sat, 8 Jun 2024 13:41:05 +1000 Subject: [PATCH 08/11] Update CONTRIBUTING.md [no ci] Co-authored-by: compilade --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2e82f135d7a22..710ef8b3c03d8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,4 +11,4 @@ * Please rate the complexity of your PR (i.e. `easy`, `medium`, `hard`). This makes it easier for maintainers to triage the PRs. * If the 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: `: (#)`. For example: `utils: Fix typo in utils.py (#1234)` +* When squashing multiple commits on merge, use the following format for your commit title: ` : (#)`. For example: `utils : Fix typo in utils.py (#1234)` From 215756019e46384b81a6f76bc6794dc7891bafc1 Mon Sep 17 00:00:00 2001 From: Brian Date: Sun, 9 Jun 2024 12:49:21 +1000 Subject: [PATCH 09/11] Update README.md --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 981a795dd0213..8680460aab700 100644 --- a/README.md +++ b/README.md @@ -1088,7 +1088,6 @@ 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](.github/PULL_REQUEST_TEMPLATE/pull_request_template.md) 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) From 9fef7a8e37001a755c15538cfb92257de3471c7e Mon Sep 17 00:00:00 2001 From: Brian Date: Sun, 9 Jun 2024 13:11:51 +1000 Subject: [PATCH 10/11] Update pull_request_template.md [no ci] --- .github/PULL_REQUEST_TEMPLATE/pull_request_template.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md index 278533b3429ec..0852fded5867e 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -1 +1,5 @@ +- Self Reported Review Complexity: + - [ ] Review Complexity : Low + - [ ] Review Complexity : Medium + - [ ] Review Complexity : High - [ ] I have read the [contributing guidelines](CONTRIBUTING.md) From 042089de535c7e28801ce2ff1d0f0f5f50e2683b Mon Sep 17 00:00:00 2001 From: Brian Date: Sun, 9 Jun 2024 13:19:59 +1000 Subject: [PATCH 11/11] Update CONTRIBUTING.md to clarify review complexity labeling [no ci] --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 710ef8b3c03d8..991d85e493be4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,7 +8,7 @@ ## PR formatting -* Please rate the complexity of your PR (i.e. `easy`, `medium`, `hard`). This makes it easier for maintainers to triage the PRs. -* If the 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. +* Please rate the complexity of your PR (i.e. `Review Complexity : Low`, `Review Complexity : Medium`, `Review Complexity : High`). This makes it easier for maintainers to triage the PRs. + - The PR template has a series of review complexity checkboxes `[ ]` that you can mark as `[X]` for your conveience. Refer to [About task lists](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists) for more information. +* If the 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: ` : (#)`. For example: `utils : Fix typo in utils.py (#1234)`