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

Overall improvements #4

Open
10 of 16 tasks
lubien opened this issue Jun 19, 2019 · 2 comments
Open
10 of 16 tasks

Overall improvements #4

lubien opened this issue Jun 19, 2019 · 2 comments
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@lubien
Copy link

lubien commented Jun 19, 2019

https://www.npmjs.com/package/vue-typing

  • "Unable to find a readme for [email protected]"
  • No keywords
  • No specific engines
  • No files field (prevent publishing useless files).
  • Coding style
  • Setup .editorconfig
  • Perhaps typing file for TypeScript users (you might not use but helps a lot those who do).
  • Add the demo URL aside repo description.
  • Maybe use Storybook as both docs, demo and development envyronment?
  • Do some unit testing

Repository

  • Improve GitHub community guidelines usage. May be optional.
    • Code of conduct
    • Contributing
    • License (highly recommended as people need a LICENSE to use it).
    • Issue templates
    • Pull request template

Feel free to ignore anything of this. These are just my recommendations.

You can learn a lot from a seasoned NodeJS developer such as Sindre Sorhus. Example repo.

@trickstival trickstival added enhancement New feature or request help wanted Extra attention is needed labels Jun 19, 2019
@trickstival
Copy link
Owner

Thanks for opening this issue, you're helping a lot.

I'm working on some of the items you pointed.

It would be great to set up some eslint config.

Maybe it would be nice to use Vuepress for the docs and put some examples there.

@lubien
Copy link
Author

lubien commented Jun 19, 2019

In my opinion the repo does not contain features enough to be worth a pipeline of static docs site.

Imho Storybook works since it's useful primarily for development but with barely further settings you can use as demo and docs site.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants