Contributing.rst 1.2 KB

1234567891011121314151617181920212223242526272829303132
  1. Contributing a plugin
  2. =====================
  3. Details of how to write a plugin is explained in the official Pelican `docs`_.
  4. If you want to contribute, please fork this repository and issue your pull
  5. request. Make sure that your plugin follows the structure below::
  6. my_plugin
  7. ├── __init__.py
  8. ├── my_plugin.py
  9. ├── test_my_plugin.py
  10. └── Readme.rst / Readme.md
  11. ``my_plugin.py`` is the actual plugin implementation. Include a brief
  12. explanation of what the plugin does as a module docstring. Leave any further
  13. explanations and usage details to ``Readme`` file.
  14. ``__init__.py`` should contain a single line with ``from .my_plugin import *``.
  15. Place tests for your plugin in the same folder with name ``test_my_plugin.py``.
  16. You can use ``test_data`` main folder, if you need content or templates in your tests.
  17. **Note:** Each plugin can contain a LICENSE file stating the license it's
  18. released under. If there is an absence of LICENSE then it defaults to the
  19. *GNU AFFERO GENERAL PUBLIC LICENSE Version 3*.
  20. Please refer to the ``LICENSE`` file for the full text of the license.
  21. .. _docs: http://docs.getpelican.com/en/latest/plugins.html#how-to-create-plugins