-
-
Notifications
You must be signed in to change notification settings - Fork 26.1k
DOC add Pull Request checklist to template #31902
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.
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
base: main
Are you sure you want to change the base?
Conversation
This text has markdown syntax, but it is in a comment, so the bullet points and bold font, etc, do not render:
|
Hey @reshamas, thanks for caring, opening this PR and tagging. I am not sure, though, because I am afraid it targets the wrong target group. Personally, I would like to make the whole contribution process easier for people, especially beginners, who are interested in interacting deeply. I don't think it helps to mandate them to also go read the FAQs and COC, before opening a PR. I am afraid this change could actually exclude / be one more barrier for potential contributors who conscientiously read instructions while it doesn't prevent fly by PRs or machines from opening PRs at all. Also, it has nothing to do with the PR if their author claims to have read the COC and these checkmarks are not expressing truth anyways. For these reasons, I would rather not review this.
I think it's fine if it doesn't render. It's only for machines. In any case, this part can stay at the very end. |
My comments:
If they have read the instructions, there should be no barrier to them checking a box for a task they have already completed.
Examples:
6) checklist
I disagree with this statement. |
I can agree with the problem but still prefer a different approach to solve it. (In particular, I also find the CoC and following through on it extremely important.) My concern is that asking contributors to read it and the long FAQs, and part of the extensive github docs and a sub-part of the FAQs again on top of the contribution guide punishes those who are already careful (that might well be people who are underrepresented in tech) while those who are careless would simply check it off without reading. |
What is the problem we are trying to solve? I think having a checklist is a good idea. Other projects do it and in some way scikit-learn also does it, but it is dressed up as bigger points. For example there is a heading about referencing an existing issue. Personally having the headings seems nicer because some of them need the author to write a few sentences. However my biggest gripe is that a lot of people just ignore the template. So maybe a combination of checklist and headings? |
Reference Issues/PRs
References #31822
References #31643
What does this implement/fix? Explain your changes.
Any other comments?
I am proposing adding a checklist to alleviate some of the recently discussed challenges of contributions.