Skip to content

Modernize source file headers #1144

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

Merged
merged 2 commits into from
Mar 3, 2020
Merged

Modernize source file headers #1144

merged 2 commits into from
Mar 3, 2020

Conversation

dcodeIO
Copy link
Member

@dcodeIO dcodeIO commented Mar 3, 2020

Source files were still using some hacky comments to be compatible with tsdoc, which turned out we don't use/need. So this PR updates the comments to a more friendly format while also including license headers.

  • The full header is present in src/index.ts
  • Other source files use a @license tag with the SPDX identifier
  • Distribution files have a single closure-library style short header

@dcodeIO
Copy link
Member Author

dcodeIO commented Mar 3, 2020

About adding my name to the headers: That's something that lately came up in a correspondence between a corporate user of long.js and me, since "The XY Contributors" was too vague for their legal department as that's not a legal entity I suppose. Now I know that a lot of open source projects do it that other way, but I guess it's always better to be safe than sorry.

@dcodeIO dcodeIO requested a review from MaxGraey March 3, 2020 16:32
@dcodeIO dcodeIO merged commit 6cee84b into master Mar 3, 2020
@dcodeIO dcodeIO deleted the header branch March 15, 2020 13:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants