Skip to content
This repository has been archived by the owner on Jun 2, 2023. It is now read-only.

Sikessem/php-package

Repository files navigation

SIKessEm logo

SIKessEm Package is released under the MIT license. GitHub Workflow Status (main) Total Downloads Latest Version PRs welcome! Follow @ske_sikessem


πŸ“¦οΈ Create a new SIKessEm Package

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

πŸ”– Contents

πŸŽ‰ Getting Started

⚑️ Installation

Install Package using Composer:

  • 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 [email protected]. 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.