Git Product home page Git Product logo

skeleton's Introduction

:package_name

Latest Version on Packagist Software License Build Status Coverage Status Quality Score Total Downloads

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/        
build/
docs/
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.

skeleton's People

Contributors

alexbilbie avatar anahkiasen avatar assertchris avatar barryvdh avatar bcrowe avatar breiteseite avatar browner12 avatar colinodell avatar dragoonis avatar emanueleminotto avatar frankdejonge avatar fulldecent avatar gmponos avatar grrnikos avatar hansott avatar hassankhan avatar jclyons52 avatar jotaelesalinas avatar kdubuc avatar maadhattah avatar marcqualie avatar marcusesa avatar odan avatar pamil avatar pborreli avatar philsturgeon avatar ravage84 avatar reinink avatar renan avatar robloach avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

skeleton's Issues

Packagist support?

Could this repository be put up on Packagist so I could just type in composer create-project league/skeleton?

make `skeleton` vendor agnostic

would you be open to a PR that replaces references to thephpleague and league with a generic :vendor placeholder? This would make the package more agnostic and serve as a good starting point for all packages.

"docs" entry in .gitignore?

Shouldn't "docs" be in .gitattributes instead of .gitignore?

This way, the documentation would be available in the repository for everybody to read but it would not be downloaded when the package is required by another project.

`composer test` don't works for windows

Output:

>composer test
You are running composer with xdebug enabled. This has a major impact on runtime performance. See https://getcomposer.org/xdebug
> phpunit
Could not open input file: <my_project_folder>\vendor\bin\/../phpunit/phpunit/phpunit

PHPUnit 6 does not work with the default ExampleTest

Detailed description

PHPUnit 6 wants PHPUnit\Framework\TestCase
but the default file has extends \PHPUnit_Framework_TestCase
so if composer install installs 6 per the composer.json options ~4.0||~5.0||~6.0
then this will break.

Context

Not sure the best solution. The user might not run composer install prior to running the prefill file so hard to fix it during setup.

Possible implementation

Maybe update the docs? I am happy to provide a fix just not sure the best way to go with it.

Your environment

  • PHP 5.6

Scrutinizer and code coverage

I used the .scrutinizer.yml file of this Skeleton. When I run an inspection on scrutinizer-ci, it times out because of the long waiting for 'external code coverage' which then ends in "Code coverage data is not yet available."
Is there something I did wrong?

Indistinct vendor variables? [Feature request]

Detailed description and context

The package_vendor variable is currently used for both the Packagist vendor name and the PSR vendor name.

I.e. I am using sander-van-hooft as my Packagist vendor name, and SanderVanHooft as my PSR vendor name, sandervanhooft as my github username.

(Yes, that's inconvenient, but it's too late to change now. )

The prefill.php and the markdown document do not make a distinction between these variables, so I end up editing them manually.

How can it benefit other users?

Possible implementation

  1. Use separate variables in the markdown files for the vendor: github_username, packagist_vendor, psr_vendor.
  2. Find a way to conveniently integrate this into the prefill.php file.

Question: phpunit or vendor/bin/phpunit?

I was wondering what the rational was behind using phpunit instead of vendor/bin/phpunit.
This seems weird to me, especially since PHPUnit is included as a Composer development dependency but may not be available globally.

Possible typo in .scrutinizer.yml

Detailed description

The file .scrutinizer.yml has a property named fix_identation_4spaces which is not the correct spelling for indentation.

It's not clear if this is a type at the configuration level (.scrutinizer.yml) or at the app that reads the configuration.

Proposal

Correct the spelling or add a comment to indicate that the misspelled word is intentional.

Unable to install the latest version of Guzzle

$ composer require guzzlehttp/guzzle
Using version ^6.2 for guzzlehttp/guzzle
./composer.json has been updated
Loading composer repositories with package information
Updating dependencies (including require-dev)
Your requirements could not be resolved to an installable set of packages.

  Problem 1
    - scrutinizer/ocular 1.3.1 requires guzzlehttp/guzzle ~3.0 -> no matching package found.
    - scrutinizer/ocular 1.3.1 requires guzzlehttp/guzzle ~3.0 -> no matching package found.
    - scrutinizer/ocular 1.3.1 requires guzzlehttp/guzzle ~3.0 -> no matching package found.
    - Installation request for scrutinizer/ocular == 1.3.1.0 -> satisfiable by scrutinizer/ocular[1.3.1].

Potential causes:
 - A typo in the package name
 - The package is not available in a stable-enough version according to your minimum-stability setting
   see <https://groups.google.com/d/topic/composer-dev/_g3ASeIFlrc/discussion> for more details.

Read <https://getcomposer.org/doc/articles/troubleshooting.md> for further common problems.

Installation failed, reverting ./composer.json to its original content.

My suggestion is to drop the composer dependency and use the downloadable phar.

Rationale behind separate namespace for tests

What is a rationale behind creating a separate namespace for tests as seen in tests/ExampleTest.php?

E.g. why one should use League\Skeleton\Test but not League\Skeleton for his ExampleTest?

How that approach is supposed to work for deeper namespaces? E.g. for League\Skeleton\Deep\EvenDeeper

Add contributors to the License

As outlined here, the copyright notice should probably be updated to include contributors.

But in the case of open source, there will likely be multiple contributors, each retaining their own copyright. You might write something like Copyright [year] Alison, Ben, and Charlie, but as the number of developers grow, things will quickly get out of hand. So lets simplify things and just write, Copyright [year] the [project] contributors.

if you want to be super technical, there’s no reason you couldn’t say [project founder] and the [project name] contributors. In either case, just putting the project founder or maintainer is strictly speaking wrong, assuming others have contributed.

How about updating LICENSE.MD to say something like:

Copyright (c) 2016 :author_name <:author_email> and the :package_name contributors

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.