development.rst 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. .. raw:: html
  2. <div id="banner"><a href="https://github.com/jcbrand/converse.js/blob/master/docs/source/development.rst">Edit me on GitHub</a></div>
  3. .. _development:
  4. ===========
  5. Development
  6. ===========
  7. Welcome to the developer documentation of Converse.
  8. Read the documentation linked to below, if you want to add new features or
  9. create your own customized version of Converse.
  10. Converse has a plugin architecture (see `pluggable.js <https://github.com/jcbrand/pluggable.js/>`_)
  11. which lets you add new features or modify existing functionality without having to touch
  12. the core files (in the `src/ <https://github.com/conversejs/converse.js/tree/master/src>`_ directory).
  13. This is the recommended way to customize or add new functionality to Converse.
  14. Plugins are especially useful if you want to add proprietary modifications, since the
  15. Mozilla Public License version 2 doesn't require you to open source your
  16. plugins. Be aware that this doesn't apply when you intend to use libsignal for
  17. OMEMO encryption because libsignal's license is GPLv3.
  18. Refer to the section on `plugin development <https://conversejs.org/docs/html/plugin_development.html>`_
  19. for more info on how to write plugins.
  20. Converse is a community project and largely volunteer driven.
  21. We're grateful for your contributions, so please don't hesitate to
  22. make a `Github pull request <https://help.github.com/categories/collaborating-with-issues-and-pull-requests/>`_
  23. to fix a bug or to add new functionality.
  24. .. toctree::
  25. :maxdepth: 2
  26. dependencies
  27. style_guide
  28. plugin_development
  29. api/index
  30. testing
  31. other_frameworks
  32. builds