From 28405283490be26bbc08a0f63656dd2e5c223684 Mon Sep 17 00:00:00 2001 From: "K.B.Dharun Krishna" Date: Mon, 27 Oct 2025 21:19:13 +0530 Subject: [PATCH 1/5] .github/PR-template: update comment and checklist to discourage AI-generated contributions --- .github/PULL_REQUEST_TEMPLATE.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index cf875c2f385469..e66b9ea5ebb48b 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,15 +1,23 @@ -#### If you are a new contributor to the project, do not use AI to generate pages. We will close any PR with a suspicion of AI usage. +#### Checklist - [ ] The page(s) are in the correct platform directories: `common`, `linux`, `osx`, `windows`, `sunos`, `android`, etc. - [ ] The page description(s) have links to documentation or a homepage. - [ ] The page(s) follow the [content guidelines](/tldr-pages/tldr/blob/main/CONTRIBUTING.md#guidelines). - [ ] The page(s) follow the [style guide](/tldr-pages/tldr/blob/main/contributing-guides/style-guide.md). - [ ] The PR contains at most 5 new pages. +- [ ] The PR's content has been proofread by me and it isn't completely generated by AI or machine translation tools. - [ ] The PR title conforms to the recommended [templates](/tldr-pages/tldr/blob/main/CONTRIBUTING.md#commit-message-and-pr-title). - **Version of the command being documented (if known):** From f28f609ab67660597ca95810f222e9932895025f Mon Sep 17 00:00:00 2001 From: "K.B.Dharun Krishna" Date: Mon, 27 Oct 2025 21:29:07 +0530 Subject: [PATCH 2/5] Update .github/PULL_REQUEST_TEMPLATE.md Co-authored-by: Managor <42655600+Managor@users.noreply.github.com> --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index e66b9ea5ebb48b..a1700c8c7b0e11 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -11,7 +11,7 @@ AI or machine translation will be closed. --> -#### Checklist +### Checklist - [ ] The page(s) are in the correct platform directories: `common`, `linux`, `osx`, `windows`, `sunos`, `android`, etc. - [ ] The page description(s) have links to documentation or a homepage. From 2a8ba5f6acfcaf5a3f0556c34165627ea944c778 Mon Sep 17 00:00:00 2001 From: Dharun Krishna K B Date: Mon, 27 Oct 2025 21:48:11 +0530 Subject: [PATCH 3/5] cleanup: move AI contribution comment to CONTRIBUTING Signed-off-by: Dharun Krishna K B --- .github/PULL_REQUEST_TEMPLATE.md | 7 ------- CONTRIBUTING.md | 5 +++++ 2 files changed, 5 insertions(+), 7 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index a1700c8c7b0e11..b0689d01dca4d3 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,13 +2,6 @@ Thank you for contributing! Please fill in the following checklist, removing items that do not apply. See also https://github.com/tldr-pages/tldr/blob/main/CONTRIBUTING.md. - -NOTE: We strongly discourage using generative AI tools to create new pages, -as their output is often inaccurate and may not follow our style guidelines. -Machine translation tools may be used for reference, but their results must be thoroughly -proofread before submission. Any pull request suspected of being generated entirely by -AI or machine translation will be closed. - --> ### Checklist diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5148418b0f7987..e3d473a936665e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,6 +31,11 @@ To get started, please [sign](https://cla-assistant.io/tldr-pages/tldr) the > [!NOTE] > When submitting a new command, please base your PR against the `main` branch and check if there's already a pull request in progress for it. +> [!WARNING] +> We strongly discourage using generative AI tools to create new pages, +as their output is often inaccurate and may not follow our style guidelines. For translations, Machine translation tools may be used as reference, but their results must be thoroughly proofread before submission. +> Any pull request suspected of fully being generated by AI or machine translation will be closed. + ## Guidelines The basic format of a `tldr` page is a set of concrete usage examples. From 8c1c5b781ca73f4a28de9b48756bb478a3bfe82d Mon Sep 17 00:00:00 2001 From: "K.B.Dharun Krishna" Date: Tue, 28 Oct 2025 20:10:35 +0530 Subject: [PATCH 4/5] Apply suggestions from code review Co-authored-by: Managor <42655600+Managor@users.noreply.github.com> Co-authored-by: Seth Falco --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- CONTRIBUTING.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index b0689d01dca4d3..4deafc2cc02d3f 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -11,6 +11,6 @@ See also https://github.com/tldr-pages/tldr/blob/main/CONTRIBUTING.md. - [ ] The page(s) follow the [content guidelines](/tldr-pages/tldr/blob/main/CONTRIBUTING.md#guidelines). - [ ] The page(s) follow the [style guide](/tldr-pages/tldr/blob/main/contributing-guides/style-guide.md). - [ ] The PR contains at most 5 new pages. -- [ ] The PR's content has been proofread by me and it isn't completely generated by AI or machine translation tools. +- [ ] The PR is authored by me, or has been human-reviewed if it was created with AI or machine translation software. - [ ] The PR title conforms to the recommended [templates](/tldr-pages/tldr/blob/main/CONTRIBUTING.md#commit-message-and-pr-title). - **Version of the command being documented (if known):** diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e3d473a936665e..3a58fb694f3e60 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -33,8 +33,8 @@ To get started, please [sign](https://cla-assistant.io/tldr-pages/tldr) the > [!WARNING] > We strongly discourage using generative AI tools to create new pages, -as their output is often inaccurate and may not follow our style guidelines. For translations, Machine translation tools may be used as reference, but their results must be thoroughly proofread before submission. -> Any pull request suspected of fully being generated by AI or machine translation will be closed. +as their output is often inaccurate and may not follow our style guidelines. For translations, machine translation tools may be used as reference, but their results must be thoroughly proofread before submission. +> Pull requests suspected of being made in whole or in part through generative AI or machine translation software without human-review will be closed. ## Guidelines From 1cdba3cd476ac16769568f2d2943ef972bed1ab5 Mon Sep 17 00:00:00 2001 From: "K.B.Dharun Krishna" Date: Tue, 28 Oct 2025 20:11:35 +0530 Subject: [PATCH 5/5] fix: warning formatting --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3a58fb694f3e60..0f81c292a593f8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -32,8 +32,8 @@ To get started, please [sign](https://cla-assistant.io/tldr-pages/tldr) the > When submitting a new command, please base your PR against the `main` branch and check if there's already a pull request in progress for it. > [!WARNING] -> We strongly discourage using generative AI tools to create new pages, -as their output is often inaccurate and may not follow our style guidelines. For translations, machine translation tools may be used as reference, but their results must be thoroughly proofread before submission. +> We strongly discourage using generative AI tools to create new pages, as their output is often inaccurate and may not follow our style guidelines. +> For translations, machine translation tools may be used as reference, but their results must be thoroughly proofread before submission. > Pull requests suspected of being made in whole or in part through generative AI or machine translation software without human-review will be closed. ## Guidelines