623db82a57
Fixed typos Update README.md Ninja 5.6 test Update README.md Update CONTRIBUTING.md Update CONTRIBUTING.md update skeleton project Switched to composer require Remove version from composer require Composer detects the latest stable version (only 0.x should specify the version) http://blog.doh.ms/2014/10/13/installing-composer-packages/ Update README.md Fix duplicate require-dev entry Update LICENSE to use Markdown Update LICENSE.md link Add .gitattributes file Fix documentation Fix typo Remove extra newline Added php_analyzer: true to scritunizer Rename scrutinizer.yml to .scrutinizer.yml updated scrutinizer reference consistent headlines in CHANGELOG.md This fits also more into the style from http://keepachangelog.com/ Harmonize package variables fix syntax in CHANGELOG.md Readme: use relative paths to CONTRIBUTING.md and contributors new year update copyright year remove duplicate field the `:author_website` option was listed twice Add a security section Add Ocular as dev-dependency, fixes HHVM issues too apparently Updated package name to be able to submit to Packagist Reverting Typo in README.md Update SkeletonClass.php Added php 7.0 and allow it to fail Added php 7.0 and allow it to fail Removed PHP 5.3 Removed --dev flag According to Travis-Ci, "You are using the deprecated option "dev". Dev packages are installed by default now." travis: PHP 7.0 nightly added simplifies configuration This removes a few settings that had no effect anymore. Update CONTRIBUTING.md Not everyone may be familiar with the term (or the details of) "squashing." A link to the git documentation would be helpful in this case. Added editor configuration Add use of Composer scripts like 'composer test' Update `composer test` to simply use `phpunit` Encourage developers to read the change log docs(testing): Update testing to use composer test https://getcomposer.org/doc/articles/scripts.md#writing-custom-commands Added end_of_line & some more info about this file > It is acceptable and often preferred to leave certain EditorConfig properties unspecified. For example [...] if a property is not standardized in your project (end_of_line for example), it may be best to leave it blank. http://editorconfig.org/#file-format-details I added ``end_of_line`` nonetheless, as I think there is an agreement to always use ``lf``. [Travis] Test lowest version dependencies Use Packagist Release badge instead of GH release Because most repos don't do releases, they just tag their revisons. Which suffices for Composer/Packagist - but the current badge would simply state "Release: None"... Alternatively the GH Tag badge could be used instead. Do not call ocular in PHP 7.0 and HHVM We cannot be dead certain that those support code coverage, so they would break the Scrutinizer build the following message "Scrutinizer was notified that the tests failed." even though all builds succeeded. At the moment HHVM seems to work, excluding it nonetheless. Also now it correlates with three runs configured in |
||
---|---|---|
src | ||
tests | ||
.editorconfig | ||
.gitattributes | ||
.gitignore | ||
.scrutinizer.yml | ||
.styleci.yml | ||
.travis.yml | ||
CHANGELOG.md | ||
CODE_OF_CONDUCT.md | ||
composer.json | ||
CONTRIBUTING.md | ||
ISSUE_TEMPLATE.md | ||
LICENSE.md | ||
phpcs.xml.dist | ||
phpunit.xml.dist | ||
prefill.php | ||
PULL_REQUEST_TEMPLATE.md | ||
README.md |
:package_name
Note: Replace :author_name
:author_username
:author_website
:author_email
:vendor
:package_name
:package_description
with their correct values in README.md, CHANGELOG.md, CONTRIBUTING.md, LICENSE.md and composer.json files, then delete this line. You can run $ php prefill.php
in the command line to make all replacements at once. Delete the file prefill.php as well.
This is where your description should go. Try and limit it to a paragraph or two, and maybe throw in a mention of what PSRs you support to avoid any confusion with users and contributors.
Structure
If any of the following are applicable to your project, then the directory structure should follow industry best practices by being named the following.
bin/
config/
src/
tests/
vendor/
Install
Via Composer
$ composer require :vendor/:package_name
Usage
$skeleton = new League\Skeleton();
echo $skeleton->echoPhrase('Hello, League!');
Change log
Please see CHANGELOG for more information on what has changed recently.
Testing
$ composer test
Contributing
Please see CONTRIBUTING and CODE_OF_CONDUCT for details.
Security
If you discover any security related issues, please email :author_email instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.