tips-and-tricks-publishing-javascript-plugins-at-github

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

tips-and-tricks-publishing-javascript-plugins-at-github

★ 10 Open GitHub ↗

No description available.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

Tips and tricks publishing javascript plugins at github
---------------------

[![Join the chat at https://gitter.im/JoanClaret/tips-and-tricks-publishing-javascript-plugins-at-github](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/JoanClaret/tips-and-tricks-publishing-javascript-plugins-at-github?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

### Name

* Choose a comprehensive and descriptive name (this will make easier to find for search engines, crawlers and people). Example: [angular-local-storage](https://github.com/grevory/angular-local-storage)

* If necessary, use "-" to separate words (DynamicMaxHeight is a bad example)

### Readme file

* Use a well structured readme file. [Boilerplate boilerplate](https://github.com/ajpiano/boilerplate-boilerplate) is a good starting point.

* Describe detailed installation instructions if necessary. Easy to understand for all kind of developers. [Elboletaire](https://github.com/elboletaire/)'s [tabbedcontent](https://github.com/elboletaire/tabbedcontent) is a great example of that.
 
* Online demos are absolutely necessary in all plugins that can be tested online. [jcSlider](http://joanclaret.github.io/jcSlider/) uses a great one.

* Use a preview image if you can. This will make easier to understand for users who are too lazy to read. [Sweet alert](https://github.com/t4t5/sweetalert) is a great example.

* Include your own, or third parties browser support badges. [xtend](https://github.com/Raynos/xtend) have a great ones.

* Encourage people to follow and star your plugin. Directly. Because why not.

* Specify a license for your plugin and include it in the readme file, so everyboy will know the software permissions and warranties.

### Promotion

* Publish your plugin in [npm](https://www.npmjs.com/) or [bower](http://bower.io/). If possible, make it [browserify](http://browserify.org/) and [require](http://requirejs.org/) ready. Many people use it.

* Publish your plugin in other pages such as [jqueryplugins](http://jquery-plugins.net/SubmitPlugin), [jqueryrain.com](http://www.jqueryrain.com/submit-your-tutorial/)... and all you can find.

* Create a [github page](https://pages.github.com/) for your plugin. This will give a profesional style and will dive traffic to the plugin. Use github predefined themes, or [download a template](http://html5up.net/) if you don't have time to create your own. [Slide-and-swipe-menu](http://joanclaret.github.io/slide-and-swipe-menu/) is a good example.

* Publish your plugin in related linkedIn group pages such as [jQuery](https://www.linkedin.com/grp/home?gid=100943), [Javascript](https://www.linkedin.com/grp/home?gid=121615), [Front-end developer network](https://www.linkedin.com/grp/home?gid=4078515).

* If you have various plugins, show them as **"other interesting plugins"** or **"more from this author"** at the bottom of the readme.md file, using your plugin page URL. This will be useful for users, and will create more incoming links (from github, npm, jqueryrain ...) to your plugin pages, which is also good for SEO purposes.  (github and  other pages links does not have "nofollow" attribute).

### Code

* Use code styleguides. For example [Google](https://github.com/google/styleguide) or [Airbnb](https://github.com/airbnb/javascript) styleguides. Better code suggest a better plugin.
* Use an organized folders structure. [Nucliweb](https://github.com/nucliweb/) use a [great one](https://github.com/nucliweb/nucliweb-Boilerplate) for html/js/sass projects, but you can find many others suitable for your plugin.
* Test your code and add badges. [https://travis-ci.org](https://travis-ci.org)

### Statistics

* Check your [repository traffic](https://github.com/blog/1672-introducing-github-traffic-analytics) stats regularly and try to learn from them.

### The community
* Encourage people to improve it. Fork and improve also this guide if you want!

tips-and-tricks-publishing-javascript-plugins-at-github

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README