jflex icon indicating copy to clipboard operation
jflex copied to clipboard

use SPDX license identifiers and make JFlex "REUSE" compliant

Open lsf37 opened this issue 5 years ago • 4 comments

SPDX is a good way to keep track of which licenses are being used in a project and I think it would make sense to use them consistently in JFLex -- for ourselves, but also to enable others to check licenses automatically. @regisd has already started using them in new parts of the repo, and I think that's great, we should do that everywhere.

More concretely, I'd propose:

  • for files that we wrote and own the copyright on, replace most of the copyright header with:
    • one or more copyright lines (authors)
    • one SPDX-License-Identifier line
    • this would remove the VERSION comment on java files, but we have that in javadoc almost everywhere now, so removing it removes duplication
  • for 3rd-party files, leave the copyright header as is, but add an SPDX-License-Identifier line as a separate comment.
  • for all files that are not commentable, use a dep5 file that lists license and copyright
  • review our own documentation files and put those under CC-BY-SA-4.0 if we haven't already done so
  • use resue lint (see http://github.com/reuse-tool) to check coverage
  • include reuse lint in CI

lsf37 avatar Mar 07 '20 00:03 lsf37

@regisd, @sarowe would you be happy for me to go ahead with this?

lsf37 avatar Mar 07 '20 00:03 lsf37

+1 LGTM

On Mar 6, 2020, at 7:43 PM, Gerwin Klein [email protected] wrote:

@regisd https://github.com/regisd, @sarowe https://github.com/sarowe would you be happy for me to go ahead with this?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/jflex-de/jflex/issues/742?email_source=notifications&email_token=AAHIPAUJC7OLU3NXVWJRJS3RGGKCJA5CNFSM4LDKQMXKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEODJF2A#issuecomment-596021992, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAHIPARZTXSTHF6CKLT45FDRGGKCJANCNFSM4LDKQMXA.

sarowe avatar Mar 07 '20 18:03 sarowe

+1 Sure

regisd avatar Mar 16 '20 22:03 regisd

Cool, will go ahead with this.

lsf37 avatar Mar 17 '20 01:03 lsf37