{"id":13518514,"url":"https://github.com/AOEpeople/Magento-2-Module-Skeleton","last_synced_at":"2025-03-31T10:31:57.433Z","repository":{"id":140858405,"uuid":"88519092","full_name":"AOEpeople/Magento-2-Module-Skeleton","owner":"AOEpeople","description":"This Module provides a basic Skeleton for further Magento 2 Modules.","archived":true,"fork":false,"pushed_at":"2017-05-30T07:36:22.000Z","size":30,"stargazers_count":31,"open_issues_count":1,"forks_count":15,"subscribers_count":28,"default_branch":"master","last_synced_at":"2025-03-25T11:48:09.823Z","etag":null,"topics":["magento-2","magento2","magento2-extension","magento2-module","magento2-project","skeleton","skeleton-template"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AOEpeople.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2017-04-17T14:58:16.000Z","updated_at":"2023-03-26T14:05:35.000Z","dependencies_parsed_at":"2023-05-04T22:25:18.111Z","dependency_job_id":null,"html_url":"https://github.com/AOEpeople/Magento-2-Module-Skeleton","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AOEpeople%2FMagento-2-Module-Skeleton","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AOEpeople%2FMagento-2-Module-Skeleton/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AOEpeople%2FMagento-2-Module-Skeleton/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AOEpeople%2FMagento-2-Module-Skeleton/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AOEpeople","download_url":"https://codeload.github.com/AOEpeople/Magento-2-Module-Skeleton/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246453667,"owners_count":20779991,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["magento-2","magento2","magento2-extension","magento2-module","magento2-project","skeleton","skeleton-template"],"created_at":"2024-08-01T05:01:45.695Z","updated_at":"2025-03-31T10:31:57.120Z","avatar_url":"https://github.com/AOEpeople.png","language":"PHP","funding_links":[],"categories":["PHP"],"sub_categories":[],"readme":"# WIP - Magento 2 Module Skeleton [![Dependency Status](https://www.versioneye.com/user/projects/59214d51da94de0056ebdda2/badge.svg?style=flat-square)](https://www.versioneye.com/user/projects/59214d51da94de0056ebdda2)\n\nIf you decided to make an open source module, you should make sure that ever body understand what you did. To make your work less harder, \nI want to provide a Skeleton Module. Checkout this module, remove the parts you do not need and fill out the gabs you think they are useful.\n\n\u003ch1 align=\"center\"\u003e\n\t\u003cbr\u003e\n\t\u003ca href=\"https://www.aoe.com/en/home.html\" title=\"AOE GmbH Logo - the open web company\"\u003e\u003cimg src=\"https://www.aoe.com/typo3conf/ext/aoe7lts_base/Resources/Public/Images/styling/AOE-Logo.svg\" width=\"300\" title=\"AOE GmbH - the open web company\"/\u003e\u003c/a\u003e\n\t\u003cbr\u003e\n\t\u003cbr\u003e\n\u003c/h1\u003e\n\n## Introduction\n\nThis module provides a skeleton for a new Magento 2 Module. It comes with examples, best practice advices and useful \ntemplates for documentation, specification or testing. \n\nIf you think, you have alternative methods or another way of thinking, please feel free to contribute to this skeleton.\n\nThis Skeleton tries to cover several aspects:\n\n* [Quality of Code](#quality-of-code)\n* [Legal Advices and Licenses](#legal-advices-and-licenses)\n* [Templates for Specification and Documentation](#templates-for-specification-and-documentation)\n* [Basic Setup for Tests](#basic-setup-for-tests)\n* [Tools to get up and running](#tools-to-get-up-and-running)\n\n## About this README\n\nThe README is the first step to a good documentation. This file will be used by Github / Gitlab as a homepage and every\ndeveloper will know, that there might be some useful information about the code and the structure.\n\nThe README File can contain the whole documentation, but if a module is getting bigger and bigger, it might be handy to \nuse a new directory. We call it ```doc```. Due to that, we will continue this documentation in the given directory.\n\n## Quality of Code\n\n### Magento 2 PHP Mess Detector\n\nMagento 2 uses a custom Mess Detector Ruleset. You will find it under:\n\n```\n/dev/tests/static/testsuite/Magento/Test/Php/_files/phpmd/ruleset.xml\n```\n\nTo run the Mess Detector via console, you can run: \n\n``` bash\n# Run in Magento 2 root\nphp vendor/bin/phpmd app/code/ text dev/tests/static/testsuite/Magento/Test/Php/_files/phpmd/ruleset.xml\n```\n\nor \n\n``` bash\n# Run in Magento 2 root\nphp bin/magento dev/test/run static\n```\n\n### Magento 2 PHP Code Style\n\nMagento 2 also comes with a custom Code Style Ruleset. You can run the Codesniffer via console with the following commands:\n\n``` bash\n# Run in Magento 2 root\nphp vendor/bin/phpcs .\n```\n\n### Security Advisories\n\nMake sure, your composer Packages do not contain any security issues. Validate your composer files by:\n\n- [Security Advisories by Friends of PHP](https://github.com/FriendsOfPHP/security-advisories)\n- [Roave Security Advisories](https://github.com/Roave/SecurityAdvisories)\n\n### Magento 2 Coding Standards\n\n* [Magento 2 Code demarcation standard](http://devdocs.magento.com/guides/v2.0/coding-standards/code-standard-demarcation.html)\n* [Magento 2 PHP coding standard](http://devdocs.magento.com/guides/v2.0/coding-standards/code-standard-php.html)\n* [Magento 2 Code sniffers](http://devdocs.magento.com/guides/v2.0/coding-standards/code-standard-sniffers.html)\n* [Magento 2 JavaScript coding standard](http://devdocs.magento.com/guides/v2.0/coding-standards/code-standard-javascript.html)\n* [Magento 2 jQuery widget coding standard](http://devdocs.magento.com/guides/v2.0/coding-standards/code-standard-jquery-widgets.html)\n* [Magento 2 DocBlock standard](http://devdocs.magento.com/guides/v2.0/coding-standards/docblock-standard-general.html)\n* [Magento 2 JavaScript DocBlock standard](http://devdocs.magento.com/guides/v2.0/coding-standards/docblock-standard-javascript.html)\n* [Magento 2 LESS coding standard](http://devdocs.magento.com/guides/v2.0/coding-standards/code-standard-less.html)\n* [Magento 2 HTML style guide](http://devdocs.magento.com/guides/v2.0/coding-standards/code-standard-html.html)\n\n## Legal Advices and Licenses\n\n## Templates for Specification and Documentation\n\n* [Module README Template](https://github.com/AOEpeople/Magento-2-Module-Skeleton/blob/master/src/doc/README.template.md)\n* [README Specification Template](https://github.com/AOEpeople/Magento-2-Module-Skeleton/blob/master/src/doc/README_SPECIFICATION.md)\n* [Contribution Guide Template](https://github.com/AOEpeople/Magento-2-Module-Skeleton/blob/master/src/doc/CONTRIBUTITION.template.md)\n\n### API Documentation \n\nThe following resource links are a good entry point to document API's in generell. \n\n* [RAML](http://raml.org/)\n* [Swagger](http://swagger.io/)\n\n## Common Specifications\n\nTo make sure, your project is perfectly maintained, I would recommend to use Semantic Versioning and a Changelog in a specific format. You will find more information about these two topics in the following links:\n\n* [Semantic Versioning](http://semver.org/)\n* [Changelog](http://keepachangelog.com/en/0.3.0/)\n\n## Basic Setup for Tests\n\n\n\n## Tools to get up and running\n\nThe following tools are personal recommandations and are used to handle common generating and/or documentating tasks.\n\n### Changelog Generator\n\n[https://github.com/skywinder/github-changelog-generator](https://github.com/skywinder/github-changelog-generator)\n\n### Contribution Guide Generator\n\n[https://github.com/WeAllJS/weallcontribute](https://github.com/WeAllJS/weallcontribute)\n\n### Code of Conduct Generator\n\n[https://github.com/WeAllJS/weallbehave](https://github.com/WeAllJS/weallbehave)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAOEpeople%2FMagento-2-Module-Skeleton","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FAOEpeople%2FMagento-2-Module-Skeleton","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAOEpeople%2FMagento-2-Module-Skeleton/lists"}