Docs: add PR template and AI contribution guidelines#16582
Conversation
nikola-matic
left a comment
nikola-matic
left a comment
There was a problem hiding this comment.
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. |
cameel
changed the title
cameel
changed the title
There was a problem hiding this comment.
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.
clonker
dismissed stale reviews from czepluch, r0qs, and nikola-matic
via
ed300d8
clonker
force-pushed
the
docs-add-pr-template-and-ai-contrib-guidelines
branch
2 times, most recently
from
ed300d8 to
42cc45a
Compare
clonker
force-pushed
the
docs-add-pr-template-and-ai-contrib-guidelines
branch
from
42cc45a to
4a1f87e
Compare
cameel
left a comment
cameel
left a comment
There was a problem hiding this comment.
I'd remove a bit of redundancy from the template. IMO it the shorter it is, the bigger chance that someone will actually read it :) There are also some leftover references to the comment you removed.
These are minor enough that I'm approving anyway - I'd like to see it merged soon - but would be nice if these could be addressed first.
It is folded into the PR template.
clonker
force-pushed
the
docs-add-pr-template-and-ai-contrib-guidelines
branch
from
4a1f87e to
28afc58
Compare
| - [ ] 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) |
There was a problem hiding this comment.
Looks like github does not follow the usual Markdown rules here. The line break gets rendered, which looks weird (see for example #16647).
Would be nice to fix this. A small annoyance, but now I'll be seeing that in every PR :)
There was a problem hiding this comment.
You're not the only one who'll be slightly triggered by seeing that in every PR :)
5 participants
No description provided.