Skip to content

[RFC] Change the recommended location for the license file in shared bundles #5599

Closed
@stof

Description

@stof

When writing the best practices for shared bundles years ago, the documented rule was to put the license file in Resources/meta/LICENSE.
In #5014 (comment) I suggested to change this rule to also allow having it at the root, as this is a common convention and even well-known bundles are doing this (DoctrineBundle for instance).

However, there is a new reason to encourage having it at the root: Github is introducing a new API to be able to know the license of a repository. They are doing this because they want to improve the usage of licenses among repos published on Github: https://github.com/blog/1964-open-source-license-usage-on-github-com
But according to examples I found about it, it expects the file to be at the root. I tried with SensioGeneratorBundle (which has the license file in Resources/meta) and the license API returns that the license is not found.

Given that most shared bundles are available on Github, it would make sense to recommend putting the license at the root of bundles rather than deep inside them.

what do you think @symfony/deciders ?

Metadata

Metadata

Assignees

No one assigned

    Labels

    hasPRA Pull Request has already been submitted for this issue.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions