Skip to content

Docs: add PR template and AI contribution guidelines#16582

Open
clonker wants to merge 3 commits intodevelopfrom
docs-add-pr-template-and-ai-contrib-guidelines
Open

Docs: add PR template and AI contribution guidelines#16582
clonker wants to merge 3 commits intodevelopfrom
docs-add-pr-template-and-ai-contrib-guidelines

Conversation

@clonker
Copy link
Copy Markdown
Member

@clonker clonker commented Apr 8, 2026

No description provided.

@clonker clonker marked this pull request as ready for review April 8, 2026 09:20
nikola-matic
nikola-matic previously approved these changes Apr 9, 2026
Copy link
Copy Markdown
Contributor

@nikola-matic nikola-matic left a comment

Choose a reason for hiding this comment

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

I like this in principle and wouldn't be against merging it as is - the only 'negative' point about it is that I think we should have some automation for this (a separate job, or at least an automatic comment on external PRs), otherwise this will just get lost amongst the rest of our contribution guidelines, which most people don't seem to read anyway :)

@r0qs
Copy link
Copy Markdown
Member

r0qs commented Apr 9, 2026

I like this in principle and wouldn't be against merging it as is - the only 'negative' point about it is that I think we should have some automation for this (a separate job, or at least an automatic comment on external PRs), otherwise this will just get lost amongst the rest of our contribution guidelines, which most people don't seem to read anyway :)

Maybe we can also add a similar message to the external PR action: https://github.com/argotorg/solidity/blob/develop/.github/workflows/welcome-external-pr.yml. It already mentions the contributing section of the docs, but it might be worth repeating that information in the bot comment as well.

r0qs
r0qs previously approved these changes Apr 9, 2026
@cameel cameel changed the title Docs add pr template and ai contribution guidelines Docs add PR template and AI contribution guidelines Apr 9, 2026
@cameel cameel changed the title Docs add PR template and AI contribution guidelines Docs: add PR template and AI contribution guidelines Apr 9, 2026
Comment thread docs/contributing.rst Outdated
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.

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.

Comment on lines +5 to +8
## Checklist
- [ ] I have read the [contributing guidelines](https://docs.soliditylang.org/en/latest/contributing.html)
- [ ] I have disclosed any use of AI tools in creating this PR (see AI Disclosure section below)
- [ ] I have personally reviewed, understood, and tested every change in this PR
Copy link
Copy Markdown
Collaborator

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

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.

@clonker clonker requested a review from czepluch April 13, 2026 09:43
czepluch
czepluch previously approved these changes Apr 13, 2026
Copy link
Copy Markdown

@czepluch czepluch left a comment

Choose a reason for hiding this comment

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

Looks good to me.

Comment thread docs/contributing.rst Outdated
@clonker clonker dismissed stale reviews from czepluch, r0qs, and nikola-matic via ed300d8 April 13, 2026 12:54
@clonker clonker force-pushed the docs-add-pr-template-and-ai-contrib-guidelines branch from e1e400a to ed300d8 Compare April 13, 2026 12:54
@clonker clonker force-pushed the docs-add-pr-template-and-ai-contrib-guidelines branch from ed300d8 to 42cc45a Compare April 13, 2026 12:56
@clonker clonker requested a review from cameel April 13, 2026 14:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants