-
Notifications
You must be signed in to change notification settings - Fork 30.5k
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
doc:spin off technical guide #12748
doc:spin off technical guide #12748
Conversation
What’s the motivation for this? The CONTRIBUTING.md file is where people actually go to look for this guide. (Or at least I do, when it’s there in other repositories.) |
These two comments #12744 (comment) and #12744 (comment) |
🤦 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think this is a good idea. This hides stuff we want people to read in a separate document. This will just result in fewer, not more, people reading the commit message guidelines etc.
I agree. |
I agree with @Trott on this one. I don't think CONTRIBUTING.md is so long that breaking it up helps too much. |
@mhdawson IMHO you don't agree with @Trott on the length of |
Blocked by #12744 or something equivalent
In an effort to "try to get first time contributors to read the important stuff"
In parallel to #12744 and as suggestion to address #12744 (comment) and
#12744 (comment)
I suggest spinning off the technical part of
CONTRIBUTING.md
into a new file, and leave behind just the motivation and guidelines.Checklist
Affected core subsystem(s)
doc
/cc @aqrln @Trott @addaleax