search

zendframework / zend-escaper

Escaper component from Zend Framework
BSD 3-Clause "New" or "Revised" License
332 stars 30 forks source link

Add the link to the docs in the composer.json #24

Closed stof closed 7 years ago

stof commented 7 years ago

The support section of the composer.json allows to provide info about several support channels (see https://getcomposer.org/doc/04-schema.md#support for the full list)

As the docs are available online, I'm adding the link here, allowing automated tools to benefit from the info. for instance, Packagist displays a link to the documentation when it knows it (sreenshot is for a different package, as zend-escaper will obviously not have this link yet as the PR is not merged): packagist_doc

I'm not adding the issue tracker here, because composer already adds it automatically for github repositories (when calling the API, it checks whether issues are enabled on the repo, and then injects the link to the issue tracker in the support section if there is none provided). The automated injection is better, as it is updated automatically if you rename the github repo. If you have extra support channels (IRC, mailing-list, forum, etc...), I will let you improve the metadata further.

stof commented 7 years ago

Note that you may want to perform the same for all packages (probably automating it once you determine the list you want). But I won't do it myself. I contributed this improvement for this package while linking to it for other people.

froschdesign commented 7 years ago

@stof The link is wrong. Fixed with 9f1c109

Thanks!

stof commented 7 years ago

the link is the one which is in the readme. If it is wrong, please fix it there too.

froschdesign commented 7 years ago

@stof Do not worry, it's on my plan.