Skip to content

Latest commit

 

History

History
72 lines (44 loc) · 2.7 KB

README.md

File metadata and controls

72 lines (44 loc) · 2.7 KB
Raw

:package_description

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

This repo can be used to scaffold a Strata CMS App package. Follow these steps to get started:

  1. Press the "Use template" button at the top of this repo to create a new repo with the contents of this skeleton
  2. Run "php ./configure.php" to run a script that will replace all placeholders throughout all the files
  3. Remove this block of text.
  4. Have fun creating your package.

This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.

Installation

You can install the package via composer:

composer require :vendor_slug/:package_slug

Usage

$skeleton = new VendorName\Skeleton();
echo $skeleton->echoPhrase('Hello, VendorName!');

Testing

composer test

Releasing a new version

Use the included GitHub action to create a new release. Go to https://github.com/astrogoat/skeleton/actions/workflows/release.yml click the "Run workflow" dropdown, select your version level bump, and click the "Run workflow" button. or run gh workflow run release.yml from your skeleton directory if you have the GitHub CLI installed locally.

Important: Make sure that the Miles Bot user is included in the list of users who can bypass required pull request requirement Your repo -> Settings -> Branches -> Main (edit) -> "Allow specified actors to bypass required pull requests"

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.