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.

Sign up for GitHub

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

Jump to bottom

Tidy up so we can Publicise this! #263

Open
9 tasks
nelsonic opened this issue Nov 3, 2016 · 2 comments
Open
9 tasks

Tidy up so we can Publicise this! #263

nelsonic opened this issue Nov 3, 2016 · 2 comments
Labels
help wanted T1h

Comments

@nelsonic
Copy link
Member

nelsonic commented Nov 3, 2016 •
edited
Loading

As a person new to this repo/project the README.md feels "unpolished".
This will

Tasks/Todo:

  • Re-read the readme with "shoshin" eyes and
    • substitute any "long" words for more beginner-friendly vocab.
    • correct any typos in the readme (editor with good English/grammar skills required!) e.g: piers >> peers
    • where a technical term is required ensure it is hyperlinked
    • align all "badges" on a single line for consistency
    • add instructions for how to include the goodparts badge! add instructions for how to display a goodparts badge (for all our projects!) #253
    • add some <br /> space between "main" section of readme and tldr; section
    • ... anything else that you spot that we can improve. (please leave a comment in this issue to discuss before making the change, thanks!)
  • close off all open issues so it does not look like there are "bugs" ...
@nelsonic nelsonic changed the title Tidy up the Readme Tidy up so we can Publicise this! Nov 3, 2016
@iteles
Copy link
Member

iteles commented Nov 3, 2016

Adding a line specifically around why we've gone with 'no ES6' is probably also worthwhile: #144 (comment) (thanks @eliasCodes !)

@nelsonic nelsonic added the T1h label Nov 17, 2016
@nelsonic nelsonic self-assigned this Nov 17, 2016
nelsonic added a commit that referenced this issue Nov 17, 2016
@nelsonic
[WiP] tidying up the readme see: #263
3d3fff1
@nelsonic nelsonic mentioned this issue Nov 17, 2016
Merged
nelsonic added a commit that referenced this issue Dec 3, 2016
@nelsonic
fix merge conflict in README.md for #263
cbb0fb8
nelsonic added a commit that referenced this issue Dec 4, 2016
@nelsonic
adds sample usage screenshots to "How?" section for #263
62c4ee2
@iteles
Copy link
Member

iteles commented Dec 4, 2016

#12 is also relevant here.

@nelsonic nelsonic removed their assignment Dec 4, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
help wanted T1h
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@nelsonic @iteles