Skip to content

Docs: add PR template and AI contribution guidelines #16582

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.

Sign up for GitHub

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
clonker wants to merge 3 commits into
base: develop
Choose a base branch
from
+44 −11
Open

Docs: add PR template and AI contribution guidelines #16582

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d76222f
Docs: Add AI-assisted contribution guidelines
clonker Apr 8, 2026
30098c8
Add GitHub PR template
clonker Apr 8, 2026
42cc45a
Remove external PR greeter bot comment
clonker Apr 13, 2026
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
30 changes: 30 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Copy link
Copy Markdown
Collaborator

@cameel cameel Apr 9, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

The new text partially overlaps with our current greeter. We should merge it into this template. Especially the self-review checklist would probably work better as a checkbox here.

Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
<!--
Thank you for your contribution to the Solidity compiler! A team member will follow up shortly.

If you have any questions or need our help, feel free to post them in the PR or talk to us directly on the
[#solidity-dev](https://matrix.to/#/#ethereum_solidity-dev:gitter.im) channel on Matrix.
-->

## Description

<!-- Describe the purpose of this PR. -->

## Checklist
- [ ] I have read the [contributing guidelines](https://docs.soliditylang.org/en/latest/contributing.html) and
the [review checklist](https://github.com/argotorg/solidity/blob/develop/ReviewChecklist.md)
- [ ] I have personally reviewed, understood, and tested every change in this PR
Comment on lines +12 to +15
Copy link
Copy Markdown
Collaborator

@cameel cameel Apr 9, 2026

Choose a reason for hiding this comment

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

Perhaps we should add a checkbox acknowledging that the contribution is licensed the same as the repo? That would be much lighter than the DCO someone suggested earlier.

Copy link
Copy Markdown
Member Author

@clonker clonker Apr 13, 2026

Choose a reason for hiding this comment

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

Not sure that is needed really (and/or what we'd gain from it), it is implied by contributing to a project in the first place by github's ToS. What I got from DCO is that it is 'more binding' in the sense that you really make it explicit. Don't think a checkbox in a markdown pr template does that. If you ask me, I'd just leave it as-is and not mention the license stuff here.

- [ ] I have disclosed any use of AI tools in creating this PR (see AI Disclosure section below)

## AI Disclosure
<!--
See our contributing guidelines for the full AI usage policy:
https://docs.soliditylang.org/en/latest/contributing.html#ai-assisted-contributions

If you used AI tools in any part of this PR you MUST disclose it below.
Describe which tool(s) you used and for which parts.
-->

- [ ] No AI tools were used
- [ ] AI tools were used (details below)

<!-- If AI tools were used, describe which tools and for which parts here. -->
11 changes: 0 additions & 11 deletions .github/workflows/welcome-external-pr.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,4 @@ jobs:
echo "Commenting in a newly submitted or reopened external PR: $PR"
if [[ $DRY_RUN == 'false' ]]; then
gh pr edit "$PR" --add-label "external contribution :star:"
comment_body=(
"Thank you for your contribution to the Solidity compiler! A team member will follow up shortly."
"\n\n"
"If you haven't read our [contributing guidelines](https://docs.soliditylang.org/en/latest/contributing.html) and our "
"[review checklist](https://github.com/argotorg/solidity/blob/develop/ReviewChecklist.md) before, "
"please do it now, this makes the reviewing process and accepting your contribution smoother."
"\n\n"
"If you have any questions or need our help, feel free to post them in the PR or talk to us directly on the "
"[#solidity-dev](https://matrix.to/#/#ethereum_solidity-dev:gitter.im) channel on Matrix."
)
gh pr comment $PR --body "$(IFS='' ; echo -e "${comment_body[*]}")"
fi
14 changes: 14 additions & 0 deletions docs/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,20 @@ We thoroughly review every PR and will help you get it right, but there are many

Thank you for your help!

AI-Assisted Contributions
=========================

We do not ban the use of AI tools, but we hold all contributions to the same high standard
regardless of how they are produced, and we require full transparency about their use.

Submitting AI-generated code means you have reviewed it, understand it, can explain it, and have
tested it as thoroughly as if you had written it by hand.

If you used AI tools to generate code, tests, or documentation in any part of your contribution,
disclosure in the pull request is mandatory.
If we determine that a PR contains undisclosed AI-generated content, we may close it.


Running the Compiler Tests
==========================

Expand Down