Skip to content

valkyrjaio/project-template-php

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Project Template (PHP)

A starter template for creating new PHP repositories in the Valkyrjaio organization.

This template ships with the full Valkyrja CI pipeline pre-wired (PHPStan, Psalm, PHPCodeSniffer, PHP CS Fixer, PHPArkitect, Rector, PHPUnit), a minimal composer setup, and the repository conventions used across the rest of the org. Use it as the starting point for any new PHP package, CI tool config, or integration repo — not for end-user applications built on the Valkyrja framework (use valkyrja-starter-app-php for that).

PHP Version Require Latest Stable Version License CI Status Scrutinizer Coverage Status Psalm Shepherd Maintainability Rating

Usage

Use this template (recommended)

This repository is a GitHub template. Click the Use this template button at the top of the repo to create a new repository in the Valkyrjaio organization, pre-populated with the template's structure and CI.

After Creating Your Repo

  1. Update composer.json with your package's name, description, and autoload namespace
  2. Replace the contents of src/ with your package's source code
  3. Update this README.md to describe the new package
  4. Configure the required secrets and variables — see REPOSITORY_NAMING.md for naming guidance and .github's workflow documentation for secret requirements
  5. Verify CI passes on the first commit

What's Included

  • Full CI pipeline — the same PHPStan, Psalm, PHPCodeSniffer, PHP CS Fixer, PHPArkitect, Rector, and PHPUnit configuration used across every Valkyrjaio PHP repo
  • Composer configurationcomposer.json with scripts for each CI tool, matching the org convention
  • Repository conventions — aligned with REPOSITORY_NAMING.md and VOCABULARY.md

Versioning and Release Process

This template follows semantic versioning with a major release every year, and support for each major version for 2 years from the date of release.

For more information see our Versioning and Release Process documentation.

Supported Versions

Bug fixes are provided until 3 months after the next major release. Security fixes are provided for 2 years after the initial release.

Version PHP Release Bug Fixes Until Security Fixes Until
26 8.4 – 8.6 March 31, 2026 Q2 2027 Q1 2028
27 8.5 – 8.6 Q1 2027 Q2 2028 Q1 2029
28 8.6+ Q1 2028 Q2 2029 Q1 2030

Contributing

This template is an open-source, community-driven project. Improvements to the template itself — refinements to the included CI configuration, composer setup, or documentation — are welcome.

See CONTRIBUTING.md for the submission process and VOCABULARY.md for the terminology used across Valkyrja.

Security Issues

If you discover a security vulnerability, please follow our disclosure procedure.

License

This template is open-source software licensed under the MIT license. See LICENSE.md.

About

PHP Project Template

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Languages