docs: Add 'AI-assisted contributions' section in CONTRIBUTING.md and PR field#3701
docs: Add 'AI-assisted contributions' section in CONTRIBUTING.md and PR field#3701FBruzzesi wants to merge 9 commits into
CONTRIBUTING.md and PR field#3701Conversation
FBruzzesi
added
documentation
dangotbanned
added
the
high priority
dangotbanned
changed the title
CONTRIBUTING.md and PR fieldCONTRIBUTING.md and PR field
dangotbanned
left a comment
dangotbanned
left a comment
There was a problem hiding this comment.
As we see more and more first time contributors that might be using AI, I would like to speed this up a bit.
Very much agree, and would rather get something in place now - thanks @FBruzzesi
| - [ ] Code follows style guide (ruff) | ||
| - [ ] Tests added | ||
| - [ ] Documented the changes | ||
| - [ ] If this is your first PR to narwhals, attach a screenshot of `pytest` passing locally (not CI) |
There was a problem hiding this comment.
Should we clarify what constructors should be considered here (e.g. whatever is default at the time of opening the PR)? I wouldn't expect first time contributors to set up spark and run the spark constructor tests.
| ## AI-assisted contributions | ||
|
|
There was a problem hiding this comment.
There are 2 other points I agree with from pip-tools
1
Pull Request Templates
Please do not replace the pull request template, which is part of the
maintainers' process.
2
I guess we could soften this a bit (if needed), but the main points I've emphasised
When interacting in pip-tools spaces (issues, pull requests, matrix, discord, etc.),
do not use LLMs to speak for you, except for translation or grammar edits.
This includes the creation of changelogs and PR descriptions.
Human-to-human communication is foundational to open source communities.
There was a problem hiding this comment.
That's very valid! Thanks for pointing it out
There was a problem hiding this comment.
Added the second. Not sure where to place the first one
|
Only other thing would be to add a sub/parent-issue to #3632 that we can close with this This is a policy after all 😅 |
EdAbati
left a comment
EdAbati
left a comment
There was a problem hiding this comment.
I agree with everything! thanks for putting this together :) just a minor comment but it's ok to merge if everyone else agrees
camriddell
left a comment
camriddell
left a comment
There was a problem hiding this comment.
Thanks for writing this up! No new points from me, once you wrap up any lingering feedback from @dangotbanned and @EdAbati this should be in a good spot.
4 participants
Description
Kept this first iteration as minimal as possible but still addresses 2-3 points of mentioned in #3632
As we see more and more first time contributors that might be using AI, I would like to speed this up a bit.
What type of PR is this? (check all applicable)