From 98eb2dc9303ca1f7a24635fc5eb548df3b3a8684 Mon Sep 17 00:00:00 2001 From: Your Name Date: Tue, 24 Feb 2026 12:13:08 +0530 Subject: [PATCH] docs: add pull request template and AI guidelines --- .github/pull_request_template.md | 16 ++++++++++++ CONTRIBUTING.md | 25 +++++++++++++++++++ .../community-contribute-to-precice.md | 6 +++++ 3 files changed, 47 insertions(+) create mode 100644 .github/pull_request_template.md create mode 100644 CONTRIBUTING.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000000..d85e9d4d11 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,16 @@ +## Description + + +Fixes # (issue) + +## Declaration of AI usage + + +- [ ] I have **not** used AI tools for this contribution. +- [ ] I **have** used AI tools for this contribution, but I have reviewed and I take full responsibility for the content. + + +## Checklist +- [ ] I have performed a self-review of my own code/content. +- [ ] I have read the [contributing to preCICE](https://precice.org/community-contribute-to-precice.html) page. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..efe803fe07 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,25 @@ +# Contributing to the preCICE Website + +Thank you for your interest in contributing to the preCICE website! + +## How to contribute + +Detailed guidelines on how to contribute can be found on our website: +[Contribute to preCICE](https://precice.org/community-contribute-to-precice.html) + +This includes: +- Contributing documentation and fixing typos +- Reporting issues +- Adding new tutorials +- Sharing simulation cases +- Helping other users + +## Policy on AI-generated content + +We welcome the use of AI tools (e.g., ChatGPT, Copilot, Gemini) to help you contribute. +However, we want to make sure that a human is always in control and responsible for the work contributed. +If you use AI tools, please declare them in your Pull Request and ensure that you have reviewed and understood every part of your contribution. + +## Local development + +For instructions on how to build and run the website locally, please refer to the [README.md](README.md). diff --git a/content/community/contribute/community-contribute-to-precice.md b/content/community/contribute/community-contribute-to-precice.md index 7155c7afc4..214295d8bb 100644 --- a/content/community/contribute/community-contribute-to-precice.md +++ b/content/community/contribute/community-contribute-to-precice.md @@ -40,6 +40,12 @@ and merge them as soon as possible. These pages are written in [Markdown](https://guides.github.com/features/mastering-markdown/) (a very easy language) and we also have a [cheatsheet](docs-meta-cheatsheet.html) specifically for this website. +## Policy on AI-generated content + +We welcome the use of AI tools (e.g., ChatGPT, Copilot, Gemini) to help you contribute. +However, we want to make sure that a human is always in control and responsible for the work contributed. +If you use AI tools, please declare them in your Pull Request and ensure that you have reviewed and understood every part of your contribution. + ## Reporting issues After discussing a problem in one of our [community channels](community-channels.html), we may conclude that this is a bug