Composer i readme.md

Composer

Jeżeli chcecie zdefiniować nowy projekt(NIE APLIKACJA YII) lub nowa bibliotekę trzymamy się nazewnictwa np

jagoda utworzył moduł w gilabie moebius/charts to znaczy, że:

  • w pliku composer.json nazwa jest "name": "moebius/charts"
  • w pliku composer.json namespace jest "autoload": {"psr-4": {"moebius\\charts\\" : "src/"}}

readme.md


  • Plik readme powinien zawierać dane osoby która zarządza projektem (tak trzeba wybrać kto głównie ogarnia projekt), pomoże to w zarządzaniu, wgrywaniu zmian lub nawet w ustaleniu kto może mieć wiedzę o projekcie bibliotece
  • Dodatkowo można tu wrzucić jakiś opis do instalacji/ użytkowania/ ewentualnie przykład użycia

Instalowanie aplikacji yii moze generować bład jeżeli nie dodliśmy pluginu z instalacja dokumentacja, w done nie będziem używać fxp/composer-asset-plugin tylko repozytorium i to wklejamy w composer.json

{
//...
"require": {
    "bower-asset/bootstrap": "^3.3",
    "npm-asset/jquery": "^2.2"
},
//...
"repositories": [
    {
        "type": "composer",
        "url": "https://asset-packagist.org"
    }
],
//...
}

sort-packages

Parametr konfiguracji composera który wprowadza alfabetyczne sortowanie bibliotek, ma to tylko i wyłacznie wpływ estetyczno-porządkowy

...
    "config": {
        ....
        "sort-packages": true
    },
...
Edit on GitLab