Skip to content

docs: add pull request template#806

Open
praaatap wants to merge 1 commit intoprecice:masterfrom
praaatap:add-pr-template
Open

docs: add pull request template#806
praaatap wants to merge 1 commit intoprecice:masterfrom
praaatap:add-pr-template

Conversation

@praaatap
Copy link
Contributor

Description

Added a comprehensive Pull Request template (.github/pull_request_template.md) to standardise PR submissions and ensure contributors follow community guidelines.
The template includes:

  • A concise description section.
  • Options to specify the type of change.
  • A comprehensive checklist based on existing CONTRIBUTING.md files within the precice repositories.
  • A prompt for running system regression tests for non-trivial PRs.

Fixes # N/A

Type of change

  • New feature or content (non-breaking change which adds functionality/content)
  • Bug fix (non-breaking change which fixes an issue)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Checklist:

  • My code/content follows the style guidelines of this project
  • I have performed a self-review of my own code/content
  • I have commented my code/content, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have read the contributing to preCICE page.

@MakisH MakisH added technical Technical issues on the website GSoC Contributed in the context of the Google Summer of Code labels Feb 24, 2026
Copy link
Member

@MakisH MakisH left a comment

Choose a reason for hiding this comment

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

Good point, we need something. But it should be as short as possible (regular contributors often complain about such checklists), and this currently includes a few points that don't apply.

What is mainly missing and would be very helpful here would be a declaration of AI tools used. I would like to make sure that a human is always in control of the work contributed.

Any suggestions in this direction?

Comment on lines 7 to 12
## Type of change
<!-- Please delete options that are not relevant. -->
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature or content (non-breaking change which adds functionality/content)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update
Copy link
Member

Choose a reason for hiding this comment

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

Since checklists show up as things to do, I would not use a checklist here. It also does not really help, a maintainer would add labels accordingly.

Let's rather remove:

Suggested change
## Type of change
<!-- Please delete options that are not relevant. -->
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature or content (non-breaking change which adds functionality/content)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update

- [ ] This change requires a documentation update

## Checklist:
- [ ] My code/content follows the style guidelines of this project
Copy link
Member

Choose a reason for hiding this comment

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

This is rather unclear, as we don't have such clear guidelines in this repo.

Suggested change
- [ ] My code/content follows the style guidelines of this project

- [ ] My code/content follows the style guidelines of this project
- [ ] I have performed a self-review of my own code/content
- [ ] I have commented my code/content, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
Copy link
Member

Choose a reason for hiding this comment

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

This is pretty much the documentation itself, I don't think this point needs to be explicit.

Suggested change
- [ ] I have made corresponding changes to the documentation

- [ ] I have performed a self-review of my own code/content
- [ ] I have commented my code/content, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
Copy link
Member

Choose a reason for hiding this comment

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

A bit vague. Given that the website includes both content and technicalities, more useful would be a list of common checks for technical contributions. Not sure what these would be, though, and I would only include the absolutely necessary ones.

@praaatap
Copy link
Contributor Author

Thanks a lot for the feedback ,@MakisH

  • I have updated the PR to incorporate all the points:

  • Removed the long and unclear checklists and the type of change section

  • Kept the template minimal and to the point

  • Added a clear declaration of AI usage to ensure transparency and human responsibility

  • Aligned the text with the contribution documentation

@MakisH
Copy link
Member

MakisH commented Feb 25, 2026

Thanks! There are a few points here that need further discussion, I will come back to you.

@praaatap
Copy link
Contributor Author

Thank you again for your review, @MakisH.
I’d be glad to discuss the remaining points.
Please let me know which specific aspects you would like to revisit — I’m happy to refine or simplify the template accordingly


## 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?

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.

@hanzalahwaheed
Copy link
Contributor

@praaatap hey! I added some comments. Hope they help make this PR even better!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

GSoC Contributed in the context of the Google Summer of Code technical Technical issues on the website

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants