From e05c9dd3662594bf61b05d0de6964203b933cace Mon Sep 17 00:00:00 2001 From: Shane Maloney Date: Mon, 9 Feb 2026 21:17:28 +0000 Subject: [PATCH 1/3] Update PR template --- .github/PULL_REQUEST_TEMPLATE.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 09debed..fe5beac 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -28,3 +28,16 @@ They can appear daunting but do not worry about them! Please include a summary of the changes and which issue will be addressed Please also include relevant motivation and context. --> + +## AI Assistance Disclosure 1 1 + +To support transparency and sustainable collaboration, please indicate whether AI-assisted tools were used in preparing this pull request. For further details see our [documentation on the fair and appropriate usage of AI usage documents](https://docs.sunpy.org/en/latest/dev_guide/contents/ai_usage.html) + +- [ ] No AI tools were used +- [ ] Yes, AI tools were used + +If **yes**, please briefly describe: +- AI tool(s) used (e.g., ChatGPT, GitHub Copilot): +- How they were used (e.g., debugging a failing test, drafting documentation, suggesting refactors): + +> Regardless of AI use, the human contributor remains fully responsible for correctness, design choices, licensing compatibility, and long-term maintainability. \ No newline at end of file From a67bb27649746d53f2d7040f014683116ed4950f Mon Sep 17 00:00:00 2001 From: Shane Maloney Date: Wed, 11 Feb 2026 15:53:13 +0000 Subject: [PATCH 2/3] Review updates Updated the pull request template to include AI assistance disclosure and improved clarity on AI usage. --- .github/PULL_REQUEST_TEMPLATE.md | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index fe5beac..5283fa0 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -15,6 +15,7 @@ Thank you. - Limit the first line to 72 characters or less - Be wary of posting output from Large Language Models or similar generative AI as comments on GitHub or any other platform, as such comments tend to be formulaic and low quality content. If you use generative AI tools as an aid in developing code or documentation changes, ensure that you fully understand the proposed changes and can explain why they are the correct approach and an improvement to the current state. + See our documentation on the fair and appropriate [AI usage](https://docs.sunpy.org/en/latest/dev_guide/contents/ai_usage.html). We have several automatic features that run when a pull request is open. They can appear daunting but do not worry about them! @@ -25,19 +26,22 @@ They can appear daunting but do not worry about them! ## PR Description -## AI Assistance Disclosure 1 1 +## AI Assistance Disclosure -To support transparency and sustainable collaboration, please indicate whether AI-assisted tools were used in preparing this pull request. For further details see our [documentation on the fair and appropriate usage of AI usage documents](https://docs.sunpy.org/en/latest/dev_guide/contents/ai_usage.html) + +AI tools were used for: +- [ ] Code generation (e.g., when writing an implementation or fixing a bug) +- [ ] Test/benchmark generation +- [ ] Documentation (including examples) +- [ ] Research and understanding - [ ] No AI tools were used -- [ ] Yes, AI tools were used - -If **yes**, please briefly describe: -- AI tool(s) used (e.g., ChatGPT, GitHub Copilot): -- How they were used (e.g., debugging a failing test, drafting documentation, suggesting refactors): -> Regardless of AI use, the human contributor remains fully responsible for correctness, design choices, licensing compatibility, and long-term maintainability. \ No newline at end of file +> Regardless of AI use, the human contributor remains fully responsible for correctness, design choices, licensing compatibility, and long-term maintainability. From 79daa24963214b3395c613b14a8f3d6343758014 Mon Sep 17 00:00:00 2001 From: Shane Maloney Date: Tue, 17 Feb 2026 15:29:08 +0000 Subject: [PATCH 3/3] Updated for merged AI dev doc --- .github/PULL_REQUEST_TEMPLATE.md | 4 ++-- CONTRIBUTING.md | 3 ++- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 5283fa0..aaad27e 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -13,9 +13,9 @@ Thank you. - Please use the following Git commit message style - Use the future tense ("Adds feature" not "Added feature") - Limit the first line to 72 characters or less -- Be wary of posting output from Large Language Models or similar generative AI as comments on GitHub or any other platform, as such comments tend to be formulaic and low quality content. +- **Do not post the output from Large Language Models or similar generative AI as code or comments on GitHub or any other platform.** If you use generative AI tools as an aid in developing code or documentation changes, ensure that you fully understand the proposed changes and can explain why they are the correct approach and an improvement to the current state. - See our documentation on the fair and appropriate [AI usage](https://docs.sunpy.org/en/latest/dev_guide/contents/ai_usage.html). + See our documentation on fair and appropriate [AI usage](https://docs.sunpy.org/en/latest/dev_guide/contents/ai_usage.html). We have several automatic features that run when a pull request is open. They can appear daunting but do not worry about them! diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ae39f46..2f02e0f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -26,8 +26,9 @@ This guide is designed to be straightforward and accessible, requiring no prior ### Restrictions on Generative AI Usage We expect authentic engagement in our community. -Be wary of posting output from Large Language Models or similar generative AI as comments on GitHub or any other platform, as such comments tend to be formulaic and low quality content. +**Do no post the output from Large Language Models or similar generative AI as code, issues or comments on GitHub or any other platform.** If you use generative AI tools as an aid in developing code or documentation changes, ensure that you fully understand the proposed changes and can explain why they are the correct approach and an improvement to the current state. +For more information see our documentation on fair and appropriate [AI usage](https://docs.sunpy.org/en/latest/dev_guide/contents/ai_usage.html). ### Anti Imposter Syndrome Reassurance