 |
VOOZH | about |
|
VOOZH | about |
This document describes the licensing terms for the Maho Composer Plugin and provides guidelines for contributing to the project. It covers the MIT License permissions and limitations, the contribution process, and quality standards that contributors must meet.
For information about development environment setup and local testing, see Development Environment Configuration. For details about the quality assurance infrastructure, see Development and Quality Assurance.
The Maho Composer Plugin is released under the MIT License, one of the most permissive open-source licenses available. The complete license text is located in LICENSE.txt1-22
Copyright Holder: Maho
The copyright notice and license text must be included in all copies or substantial portions of the software distributed by users or contributors.
Sources: LICENSE.txt1-3
The MIT License grants the following rights without restriction:
| Permission | Description |
|---|---|
| Use | Run the software for any purpose, commercial or non-commercial |
| Copy | Make copies of the software |
| Modify | Change the source code to suit your needs |
| Merge | Incorporate the software into other projects |
| Publish | Share the software publicly |
| Distribute | Give copies to others |
| Sublicense | Relicense the software under different terms |
| Sell | Include the software in commercial products |
All permissions are granted free of charge to any person obtaining a copy of the software.
Sources: LICENSE.txt5-10
The only condition is that the copyright notice and permission notice must be included in all copies or substantial portions of the software:
Copyright (c) Maho
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software")...
Sources: LICENSE.txt11-13
The software is provided "AS IS" without warranty of any kind. The license explicitly disclaims:
| Warranty Type | Status |
|---|---|
| Express Warranties | None provided |
| Implied Warranties | None provided |
| Merchantability | Not warranted |
| Fitness for Particular Purpose | Not warranted |
| Non-infringement | Not warranted |
Contributors and copyright holders are not liable for any claims, damages, or other liability arising from the use of the software.
Sources: LICENSE.txt15-21
Contributions to the Maho Composer Plugin are welcome. The project uses standard GitHub workflows for accepting contributions.
Diagram: Contribution Workflow with GitHub and CI Integration
The standard contribution process follows these steps:
main with a descriptive namesrc/ directorymain branchSources: Inferred from standard GitHub workflow and CI pipeline structure
All contributions must pass automated quality checks before they can be merged. The project enforces strict quality standards through GitHub Actions workflows.
Diagram: Quality Gates Enforced on All Contributions
The following quality standards are automatically enforced:
| Check | Tool | Configuration | Purpose |
|---|---|---|---|
| Composer Validation | composer validate --strict | .github/workflows/composer.yml | Ensures composer.json is valid and follows best practices |
| Static Analysis | PHPStan Level 10 | .github/workflows/phpstan.yml .phpstan.dist.neon | Type safety, strict rules, deprecation detection |
| PHP Syntax | php -l | .github/workflows/syntax-php.yml | Valid PHP syntax across versions 8.2, 8.3, 8.4 |
| Line Endings | git grep | .github/workflows/line-endings.yml | Unix line endings (LF), no Windows CRLF |
For detailed information about each check, see Static Analysis with PHPStan and Continuous Integration Workflows.
Sources: Inferred from CI workflow files referenced in Diagram 6
Before submitting a pull request, contributors should run quality checks locally to catch issues early.
This installs development dependencies including PHPStan for static analysis.
The PHPStan configuration in .phpstan.dist.neon enforces:
phpstan-strict-rulesphpstan-deprecation-rulesFor more details about PHPStan configuration, see Static Analysis with PHPStan.
This checks that the package definition is valid and follows Composer best practices.
Sources: Inferred from CI workflow configurations and development dependencies
The project contains three main plugin classes:
| Class | File | Purpose |
|---|---|---|
AutoloadPlugin | src/AutoloadPlugin.php | Manages PHP autoloading configuration |
ModmanPlugin | src/ModmanPlugin.php | Handles modman-based module deployment |
FileCopyPlugin | src/FileCopyPlugin.php | Copies assets and executables to project root |
When modifying these classes:
For architectural details, see Plugin Architecture.
The AutoloadRuntime class in src/AutoloadRuntime.php provides package discovery and classification. Changes to this class affect all three plugins.
When modifying AutoloadRuntime:
maho-source, maho-module, magento-moduleFor implementation details, see AutoloadRuntime Package Discovery.
Sources: Inferred from plugin architecture described in Diagram 1
Pull requests must include:
Pull requests should:
Sources: Standard open-source contribution practices
Write clear, descriptive commit messages that explain:
Example:
Fix symlink creation for nested modman directories
ModmanPlugin was failing to create symlinks when modman files
contained nested directory mappings. This adds proper directory
creation before symlink generation.
Fixes: #123
Sources: Standard open-source contribution practices
All pull requests are reviewed by project maintainers before merging. The review process checks:
Maintainers may request changes before approving the pull request.
Sources: Standard open-source contribution practices
Contributors can report bugs, request features, or ask questions through GitHub Issues at the repository.
Sources: Standard open-source contribution practices
Contributors are expected to:
Sources: Standard open-source community practices
If you need help contributing:
Sources: Standard open-source contribution practices
Refresh this wiki