-
Notifications
You must be signed in to change notification settings - Fork 0
Templates
Tyler Swann edited this page Mar 4, 2022
·
1 revision
Here is a brief table describing what each template contains and its use case.
Template | Description | LICENSE | README | CODE_OF_CONDUCT | CONTRIBUTING |
---|---|---|---|---|---|
DDS Template | The most basic configuration template. Creates a prototype package with a default name. Includes the package.json5, library.json5 files and src/ directory to get you started with a DDS build. | Empty file to put your own license of choice. | Contains the default name and some setup details for you. | Another empty file for you to add you own community guidelines. | The final empty file for adding your own documentation on how users can support and contribute to your project. |
Trove Template | This template contains the same prototype information as the DDS Template, however it contains information in the Supporting Docs, more geared towards creating a package to be contributed and added to The Trove Package Index. All the supporting docs and package information is subject to change at your discretion as long as it aligns with guidelines that underpin packages for The TrovePI. | The MIT License template with some adaptations to conform to the TrovePI Package Standard (default). | A file with the necessary layout for a Trove package (detailed by the documentation on the Trove GitHub repository). | A file with guidelines that align and are adapted from TrovePI's Code of Conduct. | A file with a more rigorous structure for contributions to your project. |