search

HubSpot / codegallery

Template - Clone this repo for each of your Code Gallery submissions.
https://designers.hubspot.com/code-gallery
BSD 3-Clause "New" or "Revised" License
6 stars 20 forks source link

[WIP] Propose new structure for code gallery code #1

Closed gcorne closed 5 years ago

gcorne commented 5 years ago

In order to emphasize modules as a core reusable building block and to make it easy for developers browsing the code gallery to try out a module, this PR is intended to start a conversation around strongly recommending that entries be in the form of a module and that the code be structured using the local file representation that is exposed via FTP.

bgoodies commented 5 years ago

🆒 I wonder if it is worth moving Sample.module out of top level and into a directory like src. That could make it more flexible for both the modules and snippet use cases.

gcorne commented 5 years ago

🆒 I wonder if it is worth moving Sample.module out of top level and into a directory like src. That could make it more flexible for both the modules and snippet use cases.

Yeah, I think that sounds reasonable. Not sure about the name src since I tend to associate that name with situations where there is a build process and so there is a separate output directory.

LukeSummerfield commented 5 years ago

Are we ready to merge this one @gcorne ? :)