Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info
Summary: A list of prerequisites and top-tips for creating your own custom extension.

GitHub account

You need a GitHub account to store the custom extension's source code and documentation. If you already have an account you can use this, but if not, you will need to create a new one - see https://github.com/join.

...

  • Fill in the required details for the repository:
    • Use the extension's "ID" for the Repository name, i.e. com.castsoftware.uc.nameoftheextension as explained in Prerequisites and top-tips for creating a custom extension
    • Set the repository to public
    • Tick the Initialize this repository with a README option
    • Choose a license - we recommend the GNU Lesser General Public License v3.0
    • Click the Create repository button

Image Modified

License

A license is mandatory. CAST recommends that you use the GNU Lesser General Public License v3.0 - this can be created at the same time as you create the new repository (see above), or after:

  • In GitHub, navigate to the main page of the newly created repository.
  • Click the Create new file button:

Click to enlarge:

Image Added

  • In the file name field, type LICENSE or LICENSE.md (in caps) and then to the right of the file name field, click Choose a license template:

Click to enlarge:

Image Added

  • In the new page that is displayed, choose the GNU Lesser General Public License v3.0 option, then Review and submit:

Click to enlarge:

Image Added

  • At the bottom of the page, below the commit message fields, commit the license to the master branch, then click Commit new file:

Click to enlarge:

Image Added

Source code and documentation should be uploaded to the GitHub repository

...