-
-
Notifications
You must be signed in to change notification settings - Fork 119
docs: add pull request template #806
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
praaatap
wants to merge
1
commit into
precice:master
Choose a base branch
from
praaatap:add-pr-template
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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. |
praaatap marked this conversation as resolved.
Show resolved
Hide resolved
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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.