Developer FAQ

Do I need to build my module?

Yes, you need to build your module and submit the built files as part of your CDN Request. It is recommended to test your module with the built files. However, we will build them again before we push them to the CDN to ensure that the files in the build directory are the same as the ones in the source directory.

We will not accept obfuscated code in the src directory. Your code must be fully readable or it will not be accepted.

What about API documentation?

Currently we do not offer API documentation for Gallery modules. You, as the developer, are responsible for that. You can use YUIDoc to generate your own and host them on your own server or for free on GitHub Pages.

Can I add a skin to the gallery?

Currently the Gallery does not offer skin support. As the skinning solution for YUI 3 solidifies, we will begin to add support for it. For now, you will have to include the CSS and the images in your own download file.

How do I track bugs? Does YUI offer a bug tracker?

We do not offer bug tracking for modules, you are free to use your own bug tracking system. Since a GitHub account is required to use the CDN, you get GitHub Issues for free. More information on GitHub Issues.

Can I have a separate repository for my module?

Yes, you can host your code anywhere you want. But, if you want to push the module to the CDN, you will have to copy your code from your external repository and add it to the yui3-gallery repository. Then check it in and submit a CDN request. You are not required to track all your changes in the yui3-gallery project.

How can I make my module more discoverable by users?

If your module is a plugin for, or an enhancement to an existing YUI 3 component, we suggest that you add the YUI component name as one of your module's tags so that when a user searches for modules that relate to a particular aspect of YUI 3, your module with be displayed in the search results list.

How do I build my gallery module?

You use the same tool that's used to build YUI, the YUI Builder. For complete instructions on downloading and using the YUI Build tool, see the project source on GitHub.

You can also use the Gallery Setup page to get you started.