Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
stof opened this issue Aug 4, 2015 · 8 comments
Closed
Labels
hasPR A Pull Request has already been submitted for this issue.

Comments

@stof
Copy link
Member

stof commented Aug 4, 2015

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.ghproxy.top
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 ?

@lsmith77
Copy link
Contributor

lsmith77 commented Aug 5, 2015

+1

1 similar comment
@fabpot
Copy link
Member

fabpot commented Aug 5, 2015

👍

@xabbuh
Copy link
Member

xabbuh commented Aug 5, 2015

makes sense

@fabpot
Copy link
Member

fabpot commented Aug 5, 2015

I would recommend it to be only in the root directory and allow it to be in the meta directory for BC reasons.

@stof
Copy link
Member Author

stof commented Aug 5, 2015

@fabpot agreed. this matches my idea.

@dunglas
Copy link
Member

dunglas commented Aug 5, 2015

+1

@stof
Copy link
Member Author

stof commented Aug 5, 2015

What do you think about making a blog post on symfony.com to announce this new recommendation (once we have the doc updated for it) ? It could help having bundles switching to the new location.

@Tobion
Copy link
Contributor

Tobion commented Aug 6, 2015

ref #4335

xabbuh added a commit that referenced this issue Aug 18, 2015
…rd-party bundles (javiereguiluz)

This PR was squashed before being merged into the 2.3 branch (closes #5620).

Discussion
----------

Changed the recommendation about the LICENSE file for third-party bundles

| Q             | A
| ------------- | ---
| Doc fix?      | no
| New docs?     | yes
| Applies to    | all
| Fixed tickets | #5599

Commits
-------

80c67b0 Changed the recommendation about the LICENSE file for third-party bundles
@xabbuh xabbuh closed this as completed Aug 18, 2015
@xabbuh xabbuh added the hasPR A Pull Request has already been submitted for this issue. label Aug 18, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hasPR A Pull Request has already been submitted for this issue.
Projects
None yet
Development

No branches or pull requests

6 participants