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

Fix typos and style on README. #6

Merged
merged 1 commit into from Jun 21, 2014

Conversation

Projects
None yet
2 participants
@cirosantilli
Contributor

cirosantilli commented Jun 21, 2014

  • consistently name this project as Octokat.js outside of code, with uppercase O, like the original Octokit does.
  • use correct case for project names. E.g.: Node.js instead of NodeJS, RequireJS. Found with: https://github.com/plasticboy/vim-markdown + set spell.
  • Where style was not consistent, i.e. two standards on same file, I followed http://www.cirosantilli.com/markdown-styleguide/ and made it consistent. In particular:
    • some headers had extra blank lines before and others not. I removed them to take less screen space.
    • break very long lines. Better for git diff without extra config. Some were broken and others not.
Fix typos and style on README.
- consistently name this project as `Octokat.js` outside of code,
  with uppercase `O`, like the original Octokit does.
- use correct case for project names. E.g.: `Node.js` instead of `NodeJS`,
  `RequireJS`. Found with: https://github.com/plasticboy/vim-markdown + `set spell`.
- Where style was not consistent, i.e. two standards on same file,
  I followed http://www.cirosantilli.com/markdown-styleguide/ and made it consistent. In particular:
  - some headers had extra blank lines before and others not. Removed them to take less screen space.
  - break very long lines. Better for `git diff` without extra config.
@philschatz

This comment has been minimized.

Owner

philschatz commented Jun 21, 2014

Thanks! I read through your styleguide and the rationales make a lot of sense.
I'll be using them on my projects going forward.

Regarding cirosantilli/markdown-styleguide, I assume you use index.md so jekyll renders the markdown but would a making readme.md a symbolic link work?

philschatz added a commit that referenced this pull request Jun 21, 2014

Merge pull request #6 from cirosantilli/readme-typos
Fix typos and style on README.

@philschatz philschatz merged commit 794ab23 into philschatz:master Jun 21, 2014

1 check passed

continuous-integration/travis-ci The Travis CI build passed
Details
@cirosantilli

This comment has been minimized.

Contributor

cirosantilli commented Jun 21, 2014

That's great! If you have any suggestions, please PR.

A symlink from README to index does show it directly on the GitHub home page: the only problems are:


My idea was to send every user to the website because it has a TOC, and let only contributors use it on GitHub.

Downsides of my approach:

  • harder to contribute. Requires one to clone my github.io to reproduce exactly.
  • does not update immediately: I need to add commit push from the parent repository.

Perhaps in this case it's worth to just be non DRY, manually generate the TOC, but make contribution easier.

@cirosantilli cirosantilli deleted the cirosantilli:readme-typos branch Jun 22, 2014

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment