Skip to content

Instantly share code, notes, and snippets.

@amcdnl

amcdnl/canjs_org.md

Created October 17, 2012 02:11
Show Gist options
  • Save amcdnl/3903331 to your computer and use it in GitHub Desktop.
Save amcdnl/3903331 to your computer and use it in GitHub Desktop.
Download ZIP
CanJS Project Organization
Raw
canjs_org.md

CanJS Project Organization

The CanJS project is growing rapidly. We need to make sure its easy to know what's what as it grows. We need to come up with a organization plan.

I'd like to get more users using the source code rather than downloading. It makes it easier for them to make commits, etc. But at the moment, its difficult for even me to sort out whats going on. We need to make it easy for users to find demos, docs, and tests.

If we structure it like this, we can even make the download cleaner where users can just download the code w/o all the demos and whatnot for more advanced users like us.

I feel like we should structure each module like control or model in a structure like the following:

  • module
    • docs => markdown(s)
    • tests => qunit, funcunit, test asset(s)
    • demos => demo.html, demo.css, demo.less, etc
    • dependencies => things that are specific to this module and don't make sense to source somewhere else
    • module.js
@moschel
Copy link

moschel commented Oct 17, 2012

I'm not against this, but I can't say I've found this to be a pressing problem. Is this a real problem that you've faced? What specifically is hard to understand? Are there some example folders you could point to?

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