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: add @dated/markdown-title-case #407

Merged
merged 4 commits into from May 12, 2019

Conversation

Projects
None yet
3 participants
@dated
Copy link
Contributor

commented May 10, 2019

Proposed changes

This PR adds a package to discover and fix non-title-cased titles and captions by calling yarn titles or yarn titles:fix.

Example output:

> yarn titles
 ›   Warning: Found 1 issues in docs/api/public/troubleshooting.md

     this line : Why Am I Not Seeing All my Results?
     should be : Why Am I Not Seeing All My Results?

 ›   Warning: Found 2 issues in docs/faq/desktop-wallet.md

     this line : Why Is There a Line Through a Cloud Next to my Address?
     should be : Why Is There a Line Through a Cloud Next to My Address?

     this line : When I Open my ARK Desktop Wallet I See an Empty ARK Address Which Should Have ARK Tokens in It.
     should be : When I Open My ARK Desktop Wallet I See an Empty ARK Address Which Should Have ARK Tokens in It.

 ›   Warning: Found 2 issues in docs/faq/passphrases.md

     this line : I Lost / Deleted my 2nd Passphrase Can I Still Use my ARK Account?
     should be : I Lost / Deleted My 2nd Passphrase Can I Still Use My ARK Account?

     this line : I Lost my Passphrase. Can You Guys Reset It or Reverse my Transaction?
     should be : I Lost My Passphrase. Can You Guys Reset It or Reverse My Transaction?

 ›   Warning: Found 4 issues in docs/faq/voting-delegates.md

     this line : Is Voting a Risk for my Wallet?
     should be : Is Voting a Risk for My Wallet?

     this line : How Can I Change my Vote?
     should be : How Can I Change My Vote?

     this line : Do I Have to Re-Vote When I Receive Additional ARK Tokens in my Wallet?
     should be : Do I Have to Re-Vote When I Receive Additional ARK Tokens in My Wallet?

     this line : Do I Need to Keep my Wallet Open After I Vote?
     should be : Do I Need to Keep My Wallet Open After I Vote?

 ›   Warning: Found 9 issues

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Refactoring (improve a current implementation without adding a new feature or fixing a bug)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Build (changes that affect the build system)
  • Docs (documentation only changes)
  • Test (adding missing tests or fixing existing tests)
  • Other... Please describe:

Checklist

Further comments

@ArkEcosystemBot

This comment has been minimized.

Copy link
Member

commented May 10, 2019

Thanks for submitting this pull request! A maintainer will review this in the next few days and explicitly select labels so you know what's going on.

If no reviewer appears after a week, a reminder will be sent out.

@dated

This comment has been minimized.

Copy link
Contributor Author

commented May 10, 2019

So I don't have to fix every article @boldninja writes :trollface:

dated and others added some commits May 11, 2019

@ArkEcosystemBot

This comment has been minimized.

Copy link
Member

commented May 12, 2019

A contributor has approved this PR. A maintainer will merge this PR shortly. If it shouldn't be merged yet, please leave a comment saying so and we'll wait.

Thank you for your contribution!

@faustbrian faustbrian merged commit a6e2ba4 into ArkEcosystem:master May 12, 2019

1 check passed

ci/circleci: build Your tests passed on CircleCI!
Details
@ArkEcosystemBot

This comment has been minimized.

Copy link
Member

commented May 12, 2019

Your pull request has been merged and marked as tier 5. It will earn you $5 USD.

@dated dated deleted the dated:feat/title-case-script branch May 12, 2019

@dated

This comment has been minimized.

Copy link
Contributor Author

commented May 12, 2019

Just out of curiosity: if i added the feature in the docs repository directly as opposed to it's own package, the tier would have been higher?

@faustbrian

This comment has been minimized.

Copy link
Contributor

commented May 12, 2019

Maybe, this PR simply added a third-party package and registered a new npm script so there isn't a reason to value it like it was specifically build just for our docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.