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
Closed

Conversation

refack
Copy link
Contributor

@refack refack 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

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Apr 29, 2017
@addaleax
Copy link
Member

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
Copy link
Contributor Author

refack 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
Copy link
Contributor Author

refack commented Apr 29, 2017

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

@refack refack added the blocked PRs that are blocked by other issues or PRs. label Apr 29, 2017
@aqrln
Copy link
Contributor

aqrln commented Apr 29, 2017

@refack

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

But... this is #12748.

@refack
Copy link
Contributor Author

refack commented Apr 29, 2017

🤦

@refack refack mentioned this pull request May 2, 2017
2 tasks
Copy link
Member

@Trott Trott left a 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.

@refack
Copy link
Contributor Author

refack 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 Issues that need assistance from volunteers or PRs that need help to proceed. label May 2, 2017
@mhdawson
Copy link
Member

mhdawson 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
Copy link
Contributor Author

refack 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 spinof-howto branch May 16, 2017 19:39
@refack refack restored the spinof-howto branch May 18, 2017 04:43
@refack refack deleted the spinof-howto branch June 10, 2017 22:40
@refack refack restored the spinof-howto branch September 20, 2017 20:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocked PRs that are blocked by other issues or PRs. doc Issues and PRs related to the documentations. help wanted Issues that need assistance from volunteers or PRs that need help to proceed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants