-
Notifications
You must be signed in to change notification settings - Fork 4
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
License headers in FOS bundles #14
Comments
I dont actually know what the best practice in general is for license headers, but yes I agree it would be good for us to define a standard here, so Bundles are consistent and more importantly we dont each have to wonder how to do it :) |
Maybe take some inspiration from humans.txt? :) |
@Kertz The way they look currently (copied from the way the Sf2 one looks) is fine IMO. the issue is what we write as content. |
I was suggesting something like the following in
|
The license is still in meta. The other data you place in the PROJECT section don't make much sense. We are all using different IDE (or no IDE), we speak different languages... The point is precisely to decide what we place at the top of the file. Here is the example coming from the Symfony2 framework:
|
@stof The whole idea of it is to share that we use different editors. Also about language, it's not what we speak but what we have used in the project. For example UserBundle has many translation files, so all those languages can go in there. This might not be a replacement for the license header but can avoid adding the authors in the header. Something like...
This is just an idea anyway :) |
@Kertz the I also disagree with the first line. FOSUB is not part of the Symfony package. Same for other FOS bundles.. |
@stof Agree that it would confuse users if we add editors. Just scratch the whole idea, maybe it's better to stick with the way things are done right now and add I just edited the Symfony license header but forgot to change the first line :) |
My suggestion:
|
I used this suggestion in FOSUB in my refactoring branch. I suggest to do the change in the other FOS bundles as well. |
sounds good to me. |
to be exact, I used
this is a bit different for the first sentence, and matches the way Symfony does. |
guess this can be closed |
The lincense header in the different FOS bundles are currently inconsistent (not only from a bundle to another but also inside the bundles which is a bigger issue). It would be great to choose a common one. Currently, many files have a license header refering to the guy writing the first implementation, others don't have any license headers...
Would it make sense to put a license header refering to FOS and then put the name of the authors as
@author
annotations where they belong (which is still done in some places too) ?The text was updated successfully, but these errors were encountered: