medunes/noise-php

A starter-kit for your PHP project.

PHP Noise

A starter-kit for your PHP project. It includes frequently needed boilerplate setups (ci, badges, etc.)

📦 Installation

To install this application, first ensure you have Composer installed, then:

# Create your skeleton app (feel free to change the folder name instead of the demo one)
$ composer create-project medunes/noise-php my-demo-project

# Enter your app folder
$ cd my-demo-project

# Install dependencies
$ composer setup:clean

# Run the build script (tests, etc.)
$ composer build

ℹ️ FAQ

So what is this?

This is PHP Noise !

An empty skeleton, a list of ready to customize setups.

These setups are commonly used when publishing PHP opensource projects or libraries.

I use this skeleton as a basis when I start a new project on Github.

Instead of spending time setting up configs from scratch, I'd rather customize them.

More details?

Nowadays, you don't just write some "working" code and ship it to the community.

There are a couple of disciplines you should follow in order to have your library acceptable by the community (or by yourself :) )

For example, code quality, tests, README, Documentation, License, logo, CHANGELOG, CI and many others.

I call these requirement: noise, not in a pejorative way, but maybe because writing new code is more fun than spending time fixing, testing, validating or documenting it.

Which kind of noise?

Currently, we support the following noise, but feel free to increase the volume:

• PHPUnit
• PHPStan
• Psalm
• SonarQube
• Github Actions
• PHP CS Fixer
• README
• CONTRIBUTING
• LICENSE
• LOGO
• CHANGELOG

Where to go next?

Writing noise projects for other languages: Javascript, Go, C, C++, ..

noise-php's Issues

Replace explicit keys with generic ENV placeholder

support xdebug3 in code coverage

the composer dependencies are not cached

the composer dependencies are not cached in the github workflow.
it can be faster if they’re cached (example: https://github.com/markuspoerschke/iCal/blob/2.x/.github/workflows/ci.yml#L26-L34)

Replace travis with Github actions

https://news.ycombinator.com/item?id=25338983

add a .editorconfig

add a .editorconfig that defines the code formatting (spaces, indention size etc.)

add funding template

documentation here
https://docs.github.com/en/github/administering-a-repository/displaying-a-sponsor-button-in-your-repository

name the minor version of php 8

name the minor version of php 8
https://github.com/MedUnes/noise-php/blob/master/.github/workflows/setup.yml#L10 (use “8.0” instead of “8")

Make it possible to add the boilerplate noise on top of an existing project

There should be a possibility to add the boilerplate and test configs on top of an existing project, without having to do it the other way around, i.e create noise project and copy the existing one to it.

Use a standardized changelog format

Use a standardized changelog format: https://keepachangelog.com/en/1.0.0/
It is easier to understand for the user of the package and there are even some github worklows that can automate updating the changelog file

add github templates for PRs and Bug-Reports

add github templates for PRs and Bug-Reports

add .gitignore file

activate Dependabot

activate Dependabot to retrieve automated composer updates

Add a command based solution to fill in placeholders

Add a command based solution customize the setup

• tokens & keys
• coverage
• user identity: name, repo name, username, email, php version, license, etc.
• choose which setups to keep/delete