Skip to content
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

Closed
wants to merge 1 commit into from

Conversation

@refack
Copy link
Member

commented Apr 29, 2017

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

@addaleax

This comment has been minimized.

Copy link
Member

commented Apr 29, 2017

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.)

@refack

This comment has been minimized.

Copy link
Member Author

commented Apr 29, 2017

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)
In short getting people to read the important stuff. I might have move too much tough.

@refack refack force-pushed the refack:spinof-howto branch to e45d69f Apr 29, 2017
@refack

This comment has been minimized.

Copy link
Member Author

commented Apr 29, 2017

P.S. I should come after #12748 #12744 or something equivalent has landed

@refack refack added the blocked label Apr 29, 2017
@aqrln

This comment has been minimized.

Copy link
Member

commented Apr 29, 2017

@refack

P.S. I should come after #12748 or something equivalent has landed

But... this is #12748.

@refack

This comment has been minimized.

Copy link
Member Author

commented Apr 29, 2017

🤦

@refack refack referenced this pull request May 2, 2017
2 of 2 tasks complete
Copy link
Member

left a comment

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.

@refack

This comment has been minimized.

Copy link
Member Author

commented May 2, 2017

This will just result in fewer, not more, people reading the commit message guidelines etc.

I agree.
I'll restore the "commit message guidelines", need help with resolving the "etc."

@refack refack added the help wanted label May 2, 2017
@mhdawson

This comment has been minimized.

Copy link
Member

commented May 9, 2017

I agree with @Trott on this one. I don't think CONTRIBUTING.md is so long that breaking it up helps too much.

@refack

This comment has been minimized.

Copy link
Member Author

commented May 10, 2017

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 CONTRIBUTING.md re: #12744 (comment) and #12796, but I do agree with you both. This PR is not the solution 🤷‍♂️

@refack refack closed this May 10, 2017
@refack refack deleted the refack:spinof-howto branch May 16, 2017
@refack refack restored the refack:spinof-howto branch May 18, 2017
@refack refack deleted the refack:spinof-howto branch Jun 10, 2017
@refack refack restored the refack:spinof-howto branch Sep 20, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
6 participants
You can’t perform that action at this time.