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

How to organize your repo a bit better #24

Closed
11 tasks
corysimmons opened this issue Apr 15, 2015 · 1 comment
Closed
11 tasks

How to organize your repo a bit better #24

corysimmons opened this issue Apr 15, 2015 · 1 comment

Comments

@corysimmons
Copy link
Collaborator

Also, any suggestions on how to better organize the repo, specially with respect to third party code, is greatly appreciated.

  • put all demo stuff in a /demo folder, preferably in a gh-pages branch
  • put all test stuff in a /tests folder
  • put all source stuff (.coffee, etc.) in a /src folder
  • put all distribution stuff (requirements like parser.js, etc. and vminpoly.js) in a /dist folder
  • get a fancy Bower badge http://shields.io so people can quickly see what version you're on
  • consider changing the name of the project from vminpoly to something like viewport-units-polyfill since it's not vmin specific anymore
  • "Notes" should be titled "Browser Support"
  • "TODO:" shouldn't be in your README. Create issues for anything like that.
  • Get rid of "Latest Changes:" as well and just keep logs when you package a release example
  • Get rid of the warnings throughout the README that it's a work in progress and instead create an Issue titled "Refactor" and assign "Help Wanted" to it.
  • Add installation/usage instructions (What requirement files do I need to load before vminpoly.js? Where should I put them in my HTML? Should I put them in a conditional comment so only IE8 users have to face the downloads?)

If you want help on this stuff I can open a PR. Just want to make sure you'd accept it before doing the work.

@corysimmons
Copy link
Collaborator Author

Oh, haha, I didn't realize I'd already created a checklist.

Well, here is most of that stuff done: #39

If it doesn't get merged in a few days (doubt it will since this issue has been around for several months without a word from the maintainer) I'll start maintaining the fork.

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

No branches or pull requests

1 participant