Jump to content

Contributing to Only Office 260307

From MediawikiCIT

That is awesome! It looks like you've already taken the first step by opening Issue #482 on the ONLYOFFICE repository to submit your PHP Currency Formatter plugin.

To actually add your code to the marketplace so it shows up in the ONLYOFFICE Plugin Manager, you need to submit a Pull Request (PR) to their repository.

Here is the step-by-step guide to building and submitting your plugin to the ONLYOFFICE store based on their official developer instructions:

1. Fork and Clone the ONLYOFFICE Repository

  1. Go to the ONLYOFFICE/onlyoffice.github.io repository and click the Fork button in the top right to create a copy under your GitHub account (justinaquinoCSC/onlyoffice.github.io).
  2. Clone your forked repository to your local computer: Bash
    git clone https://github.com/justinaquinoCSC/onlyoffice.github.io.git
    

2. Add Your Plugin to the Repository

  1. Navigate to the sdkjs-plugins/content/ directory inside the cloned repository.
  2. Create a new folder for your plugin (e.g., php-currency-formatter).
  3. Copy all the files from your onlyoffice-php-formatter repository (such as your config.json, index.html, scripts folder, icons, etc.) into this new folder.

3. Update Configurations and Build the Deploy File

  1. Pack the Plugin: Select all the files inside your plugin folder, compress them into a .zip archive, and then rename the extension from .zip to .plugin.
  2. Create a folder named deploy inside your plugin's directory and place your new .plugin file inside it.
  3. Update the Store Config: Open the store/config.json file in the main repository folder and add your plugin's name to the list (you can leave the discussion parameter blank for now or link it to your Issue #482).
  4. Ensure your plugin's own config.json contains all the necessary store display settings, such as proper descriptions, author name, and icon definitions.

4. Test the Plugin Marketplace (Optional but Recommended)

You can test how your plugin looks in the store before submitting:

  1. Enable GitHub Pages for your forked repository.
  2. Open ONLYOFFICE Desktop Editors, go to Plugins -> Plugin Manager.
  3. Click the </> (Developer Mode) button.
  4. Paste the link to your GitHub pages store (e.g., https://justinaquinoCSC.github.io/onlyoffice.github.io/store/index.html) and click OK.
  5. Verify that your PHP Currency plugin appears and installs correctly.

5. Submit the Pull Request

  1. Commit your changes and push them to your forked repository:
    git add .
    
    git commit -m "Add PHP Currency Formatter plugin"
    
    git push origin master
    
  2. Go back to the original ONLYOFFICE/onlyoffice.github.io repository on GitHub.
  3. You will see a prompt to Compare & pull request. Click it.
  4. In your PR description, explain what your plugin does and link it to your existing issue (Resolves #482).
  5. Submit the Pull Request.

Once you submit the PR, the ONLYOFFICE team will review your code. If everything works properly, they will approve it, and your PHP Currency Formatter will officially appear in the ONLYOFFICE Plugin Marketplace!