-
Notifications
You must be signed in to change notification settings - Fork 30k
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: change STYLE-GUIDE to STYLE_GUIDE #11460
Conversation
@joyeecheung I think you are right. Pretty much every other file uses that naming convention. I am happy to close this. Might wait for confirmation first. Please excuse the side note: If anyone has any suggestions/ideas for my first contribution to Node elsewhere let me know! :) Documentation/Javascript only pretty much. Very minimal knowledge of C++. |
@Dean-Coakley don't close, this PR could be updated to fix the file name instead of the link. |
@Dean-Coakley yeah, I'd change the PR to update the file name (and fix any links that were pointing to the old file name). cc/ @nodejs/docs |
Please could you format your commit message according to the Contributing Guidelines? Maybe something like this (if you include the
If you don't have time it can be rewritten by whoever lands this, but if you are going to help out more on the project (as I hope you do), then it saves work if you produce better commit messages. This seems like a good place to start with contributing, if you're looking for other stuff to do there is the good first contribution label. |
@gibfahn My apologise for these mistakes. I think I have fixed everything but it appears to be two commits. Er...is this ok? Or must I rebase or something? Thanks. |
@Dean-Coakley commits can be squashed when landing by whoever lands this. If you want to help further you can squash the commits and add the Thanks! |
@Dean-Coakley I'll merge this tomorrow if no one objects - I'll rebase the commits and add metadata if you want, but if you want to do it yourself, you basically need to |
I don't think that will just work, the second commit reverts the change in the first one, so you'll probably get a merge conflict. |
Oh, didn't notice that. Just squash then |
So I squash both commits? Haven't done this before. |
Mark the second commit as |
@Dean-Coakley you should have something like this: Rebasing and removing unneeded commitsThen when you save and quit, you'll get the commit message editor: Delete the first commit message lines so it looks like: Then save and quit. You should see some output like:
|
I should do git reset? |
@Dean-Coakley are you on Twitter? It's difficult to have a conversation with someone on Github (I'm @gibfahn, feel free to ping me there). EDIT: or IRC? |
@Dean-Coakley Looks like something went wrong (you've now got 4 commits in this PR). Here's what I'd suggest you do (this assumes you followed CONTRIBUTING.md and now have two remotes, git reset --hard upstream/master # Clean everything and start again
mv doc/STYLE-GUIDE.md doc/STYLE_GUIDE.md # Make the change again
git add -A # Add all files to the index
git commit
# Paste in the commit message, I've put it in below
git status # Should say 5 commits behind, 1 commit ahead
git push --force-with-lease Try that
|
Should be all good now. Thanks everyone for your help! 😄 |
Will land later today if there are no objections. |
0349d70
to
ed1a497
Compare
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.
LGTM
PR-URL: #11460 Fixes: #11456 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Claudio Rodriguez <cjrodr@yahoo.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Landed in 5f08871 Thanks for your contribution @Dean-Coakley! |
PR-URL: #11460 Fixes: #11456 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Claudio Rodriguez <cjrodr@yahoo.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
This should only land in v6 or v4 if the original style guide PR lands |
(Depends on #11321) |
PR-URL: #11460 Fixes: #11456 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Claudio Rodriguez <cjrodr@yahoo.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
PR-URL: #11460 Fixes: #11456 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Claudio Rodriguez <cjrodr@yahoo.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
PR-URL: #11460 Fixes: #11456 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Claudio Rodriguez <cjrodr@yahoo.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
PR-URL: #11460 Fixes: #11456 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Claudio Rodriguez <cjrodr@yahoo.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Changed filename of STYLE-GUIDE to STYLE_GUIDE to be consistent with naming conventions.
Changed all references to this file.
Fixes: #11456