README

📦️ Create a new SIKessEm Package

Create a template based on this repository to create your custom package.

🔖 Contents

Getting Started
Requirements
Documentation
Community
Security Reports
Contribution
License

🎉 Getting Started

⚡️ Installation

By adding the sikessem/package dependency to your composer.json file:

{
  "require" : {
    "sikessem/package": "^0.2"
  },
}

Or by including the dependency:

composer require sikessem/package --no-dev

Or by creating a new project from the template:

create-project sikessem/package --prefer-source package

🧑‍💻 Usage

<?php

use Sikessem\Package\Hello;

include_once __DIR__.'/autoload.php';

echo Hello::toYou('SIKessEm').PHP_EOL;

🧪 Testing

🧹 Keep a modern codebase with Pint:

composer lint

⚗️ Run static analysis using PHPStan:

composer test:types

✅ Run unit tests using PEST

composer test:unit

🚀 Run the entire test suite:

composer test

📋 Requirements

Requires PHP 8.1+ (at least 8.1.11 recommended to avoid potential bugs).

📖 Documentation

The full documentation for SIKessEm Packages can be found on our SIKessEm Documentation.

💬 Community

For support, you can use our GitHub Discussions.

👥 Contribution

Read our contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Package.

🔐 Security Reports

If you discover a security vulnerability within Package, please send an e-mail to SIGUI Kessé Emmanuel via ske@sikessem.com. All security vulnerabilities will be promptly addressed.

📄 License

The SIKessEm Package is open-sourced software licensed under the MIT License - see the LICENSE file for details.

Package was created by SIGUI Kessé Emmanuel.

sikessem / package

Maintainers

Details