{"action":"closed","issue":{"url":"https://api.github.com/repos/symfony/symfony-docs/issues/4335","labels_url":"https://api.github.com/repos/symfony/symfony-docs/issues/4335/labels{/name}","comments_url":"https://api.github.com/repos/symfony/symfony-docs/issues/4335/comments","events_url":"https://api.github.com/repos/symfony/symfony-docs/issues/4335/events","html_url":"https://github.com/symfony/symfony-docs/issues/4335","id":46170624,"number":4335,"title":"[RFC] Change Resources/meta/LICENSE and Resources/doc/index.rst","user":{"login":"Tobion","id":610090,"avatar_url":"https://avatars.githubusercontent.com/u/610090?v=3","gravatar_id":"","url":"https://api.github.com/users/Tobion","html_url":"https://github.com/Tobion","followers_url":"https://api.github.com/users/Tobion/followers","following_url":"https://api.github.com/users/Tobion/following{/other_user}","gists_url":"https://api.github.com/users/Tobion/gists{/gist_id}","starred_url":"https://api.github.com/users/Tobion/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Tobion/subscriptions","organizations_url":"https://api.github.com/users/Tobion/orgs","repos_url":"https://api.github.com/users/Tobion/repos","events_url":"https://api.github.com/users/Tobion/events{/privacy}","received_events_url":"https://api.github.com/users/Tobion/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/symfony/symfony-docs/labels/hasPR","name":"hasPR","color":"006b75"}],"state":"closed","locked":false,"assignee":null,"milestone":null,"comments":4,"created_at":"2014-10-18T10:44:55Z","updated_at":"2015-07-29T18:18:34Z","closed_at":"2015-07-29T18:18:34Z","body":"Currently the [best practise for reusable bundles](http://symfony.com/doc/current/cookbook/bundles/best_practices.html#directory-structure)  says \r\n\r\n> The following files are mandatory:\r\nHelloBundle.php;\r\nResources/meta/LICENSE: The full license for the code;\r\nResources/doc/index.rst: The root file for the Bundle documentation.\r\nThese conventions ensure that automated tools can rely on this default structure to work.\r\n\r\nI think it's time to change that. I would propose to simply say there should be\r\n\r\n1. a LICENSE file in the root directory and a [license property in composer.json](https://getcomposer.org/doc/04-schema.md#license)\r\n2. a README file (in any format, e.g. README.md or README.rst) in the root directory that serves as an entry point to the documentation\r\n\r\nI think this has several advantages:\r\n\r\n1. this is how Symfony itself is also structured. For example, the documentation of symfony bundles is not in Resources/doc but in a separate repository. So symfony does not follow it's own best practises at the moment.\r\n2. the LICENSE file in the root is common practise in open source but Resources/meta/LICENSE is not\r\n3. the README is also common practise, especially when using github. This also makes it independent of the format. And most bundles don't use `rst` format anyway from my experience but markdown, e.g. [FosUserBundle](https://github.com/FriendsOfSymfony/FOSUserBundle/tree/master/Resources/doc). Which would also go against the current best practise."}}