From e8f2a2dac12d91544306c1ca0ad3645d90c21c9b Mon Sep 17 00:00:00 2001 From: Georgi Gerganov Date: Sat, 30 Nov 2024 09:50:54 +0200 Subject: [PATCH 1/5] contrib : refresh --- .github/pull_request_template.md | 4 ---- CONTRIBUTING.md | 3 +-- 2 files changed, 1 insertion(+), 6 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 997c6d9d05397..f6603098e0b6c 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,7 +1,3 @@ - [x] I have read the [contributing guidelines](https://github.com/ggerganov/llama.cpp/blob/master/CONTRIBUTING.md) -- Self-reported review complexity: - - [ ] Low - - [ ] Medium - - [ ] High diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4c882c254cac5..32da00a8c21ee 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,9 +1,8 @@ # Pull requests (for contributors) - 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 + - Run the `test-backend-ops` tool to validate different backend implementations of the `ggml` operators - Execute [the full CI locally on your machine](ci/README.md) before publishing -- Optionally 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 - Consider allowing write access to your branch for faster reviews, as reviewers can push commits directly - If your PR becomes stale, don't hesitate to ping the maintainers in the comments From 04e26bc6cf336cbc7598fc37116a7451abf398a2 Mon Sep 17 00:00:00 2001 From: Georgi Gerganov Date: Sat, 30 Nov 2024 09:55:38 +0200 Subject: [PATCH 2/5] contrib : expand [no ci] --- CONTRIBUTING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 32da00a8c21ee..f1342ebc7e574 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,6 +3,7 @@ - Test your changes: - Run the `test-backend-ops` tool to validate different backend implementations of the `ggml` operators - Execute [the full CI locally on your machine](ci/README.md) before publishing + - Verify that the perplexity and the performance are not affected negatively by your changes (use `llama-perplexity` and `llama-bench`) - Consider allowing write access to your branch for faster reviews, as reviewers can push commits directly - If your PR becomes stale, don't hesitate to ping the maintainers in the comments From c66bc3e4fb6ef01eb6302a7a19c4df81fc37a2ba Mon Sep 17 00:00:00 2001 From: Georgi Gerganov Date: Sat, 30 Nov 2024 11:09:26 +0200 Subject: [PATCH 3/5] contrib : expand test-backend-ops instructions --- CONTRIBUTING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f1342ebc7e574..f5dc8ce48c594 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,9 +1,10 @@ # Pull requests (for contributors) - Test your changes: - - Run the `test-backend-ops` tool to validate different backend implementations of the `ggml` operators - Execute [the full CI locally on your machine](ci/README.md) before publishing - Verify that the perplexity and the performance are not affected negatively by your changes (use `llama-perplexity` and `llama-bench`) + - If you modified the `ggml` source, run the `test-backend-ops` tool to check whether different backend implementations of the `ggml` operators produce consistent results (this requires access to at least two different `ggml` backends) + - If you modified a `ggml` operator or added a new one, add the corresponding test cases to `test-backend-ops` - Consider allowing write access to your branch for faster reviews, as reviewers can push commits directly - If your PR becomes stale, don't hesitate to ping the maintainers in the comments From 869ea28b5db112fcfb61cc6f7b11f03bf4bb0d95 Mon Sep 17 00:00:00 2001 From: Georgi Gerganov Date: Sun, 1 Dec 2024 12:15:30 +0200 Subject: [PATCH 4/5] contrib : add CODEOWNERS --- CODEOWNERS | 3 +++ CONTRIBUTING.md | 1 + 2 files changed, 4 insertions(+) create mode 100644 CODEOWNERS diff --git a/CODEOWNERS b/CODEOWNERS new file mode 100644 index 0000000000000..88ab6de4fb618 --- /dev/null +++ b/CODEOWNERS @@ -0,0 +1,3 @@ +# collaborators can optionally add themselves here to indicate their availability for reviewing related PRs + +ci/ @ggerganov diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f5dc8ce48c594..5a85ec5d2efb4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,6 +13,7 @@ - Squash-merge PRs - Use the following format for the squashed commit title: ` : (#)`. For example: `utils : fix typo in utils.py (#1234)` - Optionally pick a `` from here: https://github.com/ggerganov/llama.cpp/wiki/Modules +- Consider adding yourself to [CODEOWNERS](CODEOWNERS) # Coding guidelines From 74069c4a5532e5ea4e7e0c50f8832c27cc35d902 Mon Sep 17 00:00:00 2001 From: Georgi Gerganov Date: Sun, 1 Dec 2024 12:22:02 +0200 Subject: [PATCH 5/5] prs : update template to not have checkbox [no ci] --- .github/pull_request_template.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index f6603098e0b6c..d9f5bdc235a00 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,3 +1 @@ - - -- [x] I have read the [contributing guidelines](https://github.com/ggerganov/llama.cpp/blob/master/CONTRIBUTING.md) +*Make sure to read the [contributing guidelines](https://github.com/ggerganov/llama.cpp/blob/master/CONTRIBUTING.md) before submitting a PR*