Submit a Plugin¶

Note

This page assumes that you have already read and completed the tasks in Getting Started and Plugin Submission Form, and have a completed plugin and submission form.

To submit a plugin, you must request that it be added to the plugin catalog. This request is made through a “Pull Request” submitted to the Rxn Rover Plugin Catalog GitHub Repository.

Making a Submission¶

The basic steps to submit a plugin to the catalog are as follows:

Create the plugin and complete the submission form as mentioned above.
Fork the Rxn Rover Plugin Catalog GitHub Repository.
Clone your fork of the plugin catalog to your local computer.
Add your submission form to <catalog_location>/source/third_party/<type>/, where <catalog_location> is the top-level directory of your forked plugin catalog and <type> is the directory corresponding to the functionality of your plugin.

Link your submission form to the catalog by adding it to the <catalog_location>/source/third_party/<type>/index.rst file in the chosen directory.

For example:

Analyzer Plugins
================

This is an example ``index.rst`` file. Your submission for will be added
to the ``toctree`` below.

.. toctree::
   :maxdepth: 1
   :caption: Infrared Spectroscopy

   example_plugin_1
   your_submission_form_without_the_extension
   example_plugin_2

Add and Commit your submission form and changes to index.rst. Example commands performing these actions follow:

# From the top-level directory
cd ./source/third_party/analyzers
git add ./example_plugin.rst ./index.rst
git commit -m "Added submission form for Example Plugin"

Push the committed changes to your forked GitHub repository.
Submit a pull request to the official plugin catalog from your fork. Once submitted, your pull request will be reviewed by someone on the team. At this stage, you may receive feedback or suggested changes before the pull request is accepted.
Once the pull request is accepted, your plugin will appear in the plugin catalog!