Skip to content

Latest commit

 

History

History
34 lines (22 loc) · 2.57 KB

README.md

File metadata and controls

34 lines (22 loc) · 2.57 KB

Concepts

A collaborative PHP package concept repository to be used for future builds.

What we're doing

Coreplex wants your input on how PHP packages should be done right. If you have an idea of a package you would like to see, and the way you would want to interact with that package, submit your pull request here it here and we will pick the best ones to build.

What concepts are we looking for?

We mainly want to see things like what a package looks like when you are using it.

The reason for this is that sometimes, too much focus goes into how a package works behind the scenes rather than how the user can actually interact with it easily.

We would rather you show us how you want to interact with the package, and we will figure out the magic that goes into making it work and give everybody open source rights to use it.

We look for ideas where the syntax is expressive, human-readable and simple. We also like innovative ideas that we can put to work. Your code doesn't have to be amazingly formatted to make a concept, it just has to be a good idea which people would love to use.

How should I submit my concept?

If you have a concept that you want to submit, first look for a category that it could sit under. For example, if you have a concept for an e-commerce basket package, you will find the cart folder within the repository. Create a folder in here with your vendor name like so:

concepts/cart/{your-vendor-name}

If you don't find one in the folder, make a pull request with the new package folder, and include your vendor name if you already have a concept:

concepts/{package-name}/{your-vendor-name}

When there are enough contributions, we will merge the best submitted concepts into the finalized/{package-name} directory as a finalized concept. We may release revisions of the concept if we feel that any better ideas have come along which we'd like to utilize.

What will happen with the concepts at finalization stage?

When a concept reaches finalization stage, it will be put into the pipeline for development and we will build the package as specified in the finalized concept.

All packages will be built to the PHP FIG standards PSR-4 and be built to be framework agnostic from the outset. We usually include Laravel 5 Service Providers and Facades for all packages we build, as it is our framework of choice, however, contributions for other framework drivers such as CodeIgniter, Yii or any other frameworks always have a place here!