Repository navigation
Repository structure and contents #2
Description
What is all that stuff in the repository?
HTML5 boiler plate
I don't think that HTML5 boiler plate should be in the root of this project.
I don't think it should be in this project in the first place.
If we want to make a site with live samples, we could make a
github page, and commit HTML5 boiler plate there instead.
Also when creating an issue this appears at top, caused by the existence of CONTRIBUTING.md:
.idea
What are these files?
They seem to be some kind of cached information from a tool that you might be using.
Please, don't commit them if you don't think these files should be shared with others.
In some projects I commit Resharper .DotSettings files and Settings.StyleCop.
They are coding style settings that I want to share with other developers.
If these .idea files have this purpose then I think it is ok, but by looking at their contents, it doesn't appear to be that.
Structure
Here is a structure that fulfils the purpose of this repository:
components\- only the code of our components: scripts and styles made by ourselvesdefault\- the default presentation structure (our own)pager.jsx- the pager component rendered with our own structureskins\- skins for our presentational structurelight\- light themed skinpager.css- skin for the pager component
dark\- dark themed skinpager.css- skin for the pager component
bootstrap-3\- components using the bootstrap-3 presentation frameworkpager.jsx- pager component rendered for bootstrap-3skins\- shouldn't exist, since bootstrap has it's own skins
samples\- samples of component usagepager-basic-samples\pager-default.html- sample using the pagerpager-bootstrap-3.html- sample using the pager with bootstrap-3 structure...
the code is the same as the above file, but including the corresponding pager.jsx filepager-sample.js- script compatible with both structures (because they can be swapped)
Notes:
- Components in different folders, but with the same name, must have the same function,
and they must be swappable:components\default\pager.jsxandcomponents\bootstrap-3\pager.jsxbehave exactly the same,
only the HTML structure is different between them.- names inside JavaScript should also be the same
- The samples should be built with component swapping in mind.
- When components are not swappable, then they must have different names, both file and inside
the JavaScript.
Thoughts?

Activity
andrerpena commentedon Feb 7, 2015
I agree. Except that I would put the components inside a
srcfolder because it seems like there's a tool calledgulpthat is widely used and it allows you to compile your code into adistfolder.andrerpena commentedon Feb 7, 2015
I'm including the .idea folder in the .gitignore
masbicudo commentedon Feb 8, 2015
Nice, I totally agree.