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

Feat/handle emojis GitHub #37

Closed

Conversation

adrianmcli
Copy link
Collaborator

Fixes #36

I added 3 tests and a dependency on emoji-regex.

@thlorenz
Copy link
Owner

Please remove the yarn stuff, that has nothing to do with the fix you're trying to do.
Also that seemed to have broken the build.

If you try to add yarn please file a PR (even though I'll refuse it). In general please keep PRs focused on one thing.

Thanks

@thlorenz
Copy link
Owner

thlorenz commented Feb 16, 2017

After you fixed the yarn thing and the issues I pointed out below, please squash all commits and push.

package.json Outdated
@@ -24,5 +24,8 @@
"gitHead": "dcde154040d17d321664a7efc38e8531330335f9",
"devDependencies": {
"tap": "~0.4.8"
},
"dependencies": {
"emoji-regex": "^6.1.0"
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use ~ as range specifier here.
I'm conservative with deps and also this avoids breaking older npms which might be the reason the build is breaking on travis right now.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sure

@@ -43,6 +43,9 @@ test('\ngenerating anchor in github mode', function (t) {
, [ 'module-specific-variables-using-jsdoc-@module', null, '#module-specific-variables-using-jsdoc-module']
, [ 'Jack & Jill', null, '#jack--jill']
, [ 'replace – or —', null, '#replace--or-']
, [ 'Modules 📦', null, '#modules-']
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this correct to have a trailing - here?
Have you tried if github does it that way?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes it is.

@adrianmcli
Copy link
Collaborator Author

@thlorenz I'm having trouble squashing the commits since this branch has already been pushed to the PR. You should be able to squash it before you merge.

squashing

@adrianmcli
Copy link
Collaborator Author

adrianmcli commented Feb 16, 2017

Here's a better example picture:

squash and merge

@thlorenz
Copy link
Owner

Sorry please squash at the command line via an interactive rebase.
Don't use the horrible UI.

add tests

strip emojis for github links

add additional test for multiple emojis

add yarn lock file

remove yarn file

use ~for emoji-regex dependency
@adrianmcli
Copy link
Collaborator Author

There, done.

@thlorenz
Copy link
Owner

Awesome, thanks now I made you collaborator.

Please merge to master following this guide.
I will then version and publish to npm.

Thanks a lot for your help.

I'll version as a patch so doctoc will automatically pick up the fix when you install it fresh.

@thlorenz
Copy link
Owner

@adrianmcli when I meant I don't want the history, I meant the commit message as well, i.e:

add yarn lock file

remove yarn file

is completely nonsensical. To me it looks like you just squashed without editing the commit message at all.
I'll fix that and force push to master, but please submit meaningful and to the point commit messages in the future.

I'll also publish as a patch to npm.

@thlorenz
Copy link
Owner

merged and ublished as 0.5.7.

@thlorenz thlorenz closed this Feb 20, 2017
@adrianmcli
Copy link
Collaborator Author

Sorry about that, I thought the whole point of the squashing was to document the history of what happened without multiple commits. I'll keep this in mind in the future.

@thlorenz
Copy link
Owner

The whole point of squashing is to erase the history we don't need to know, i.e. that you added a yarn file and then removed it.

A commit message should state what the commit does, not how you got there, but no worries, just wanted to let you know, so you can do it better next time :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants