loadsys/cakephp-plugin-skeleton

Development, build and testing tools for CakePHP (3.x & 2.x) plugin projects.

cakephp-plugin-skeleton's Issues

README.template mixes Markdown header styles.

Headers like ## Something ## should be corrected to ## Something.

Examples include the License and Copyright sections.

As a copy/paste reference, this perpetuates mistakes out into other projects.

Update Readme with instructions to setup Travis - Cake 3.x

Completed for Cake 2.x

Add Composer.json Template for Cake 2.x

Update Readme with instructions to setup Coveralls - Cake 3.x

Completed for Cake 2.x

Add to the README for the GitHub Env Var, how to install the Travis Gem

Ref: #15 (comment)

Add Travis Template for CakePHP 2.x Branch

Add Travis Template For Cake 3.x

Meta: Review all existing FOSS projects against plugin skeleton standards.

Using this list as a starting point, all projects should be brought in line with this skeleton's basic standards:

https://github.com/loadsys?utf8=%E2%9C%93&query=CakePHP-

This should be done once most of the other currently open issues are resolved. That currently includes:

• Add Travis Template For Cake 3.x #3
• Add Composer.json Template for Cake 3.x #5
• Update Readme with instructions to setup Travis - Cake 3.x #6
• Add Packagist Setup Instructions - Cake 3.x Branches #7
• Update Readme with instructions to setup Coveralls - Cake 3.x #8
• Get a Basic Skeleton for Cake 3 #9
• Add a default Code of Conduct. #19
• Add instructions for using composer create-project? #22

Get a Basic Skeleton for Cake 3

Ideas:

https://github.com/FriendsOfCake/bootstrap-ui
https://github.com/FriendsOfCake/travis/tree/cake3
https://github.com/loadsys/CakePHP-LoadsysTheme

Add Composer.json Template for Cake 3.x

Adjust .travis.yml to enable caching

Add this line to the top of the file:

sudo: false

Add these lines:

cache:
  directories:
    - vendor
    - $HOME/.composer/cache

After the matrix but before installation

Adjust .travis.yml for Cake 2.x to include the GitHub ENV PRIVATE_KEY

Ref: FriendsOfCake/travis#59 (comment)

Add instructions for using `composer create-project`?

Unless I'm not thinking of something, shouldn't it be possible to clone a new plugin project from this repo using composer's create-project command, just like we do with the full Cake "app" Skeleton?

If we do that, we could move the composer scripts in Console/ into their own composer package, and re-use them in our app skeleton and this plugin skeleton in order to do template replacement for both.

That would also help solve loadsys/CakePHP-Skeleton#72 pretty nicely, I think.

Figure out solution to enabling caching with Coveralls Issues

Ref: loadsys/CakePHP-Stateless-Auth#24

Add a default Code of Conduct.

I'm not going to link directly to it, because it's just full of the typical vileness, but the opal/opal project had an issue opened recently (941) regarding one of its developers being hostile on Twitter. (The initial post and first response are all you need to read to know how the rest will go.)

Anyway, our plugin skeleton should bundle a suitable code of conduct from the get-go. Perhaps @CoralineAda's Contributor Covenant is a place to start? (Coraline is the one that raised the Opal issue in question above.)

Projects spawned from this skeleton would of course be free to modify or remove it (if for some unfathomable reason that became necessary) but we should definitely set the proper expectations by default, just as we do with the README outline, the testing framework setup, etc. This skeleton is intended to serve as a blueprint, so let's make it a good and inclusive one, eh?

Add Packagist Setup Instructions - Cake 3.x Branches

Completed for Cake 2.x