Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions .github/pull_request_template.md
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lets add a Screenshot section as an optional section for any UI related changes. It can also include Before and After comparison views maybe.

Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
## Description
<!-- Please include a concise summary of the changes and the related issue. -->

Fixes # (issue)

## Declaration of AI usage
<!-- Did you use any AI tools (e.g., ChatGPT, Copilot, Gemini) to generate this contribution?
We want to make sure that a human is always in control of the work contributed. -->

- [ ] 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.
<!-- Please briefly specify which tools you used and where. -->

## 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.
25 changes: 25 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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).
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we absolutely need to mention the names of the AI tools here?

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
Expand Down