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

Change license header in the code #271

Closed
Shinigami92 opened this issue Aug 27, 2018 · 3 comments
Closed

Change license header in the code #271

Shinigami92 opened this issue Aug 27, 2018 · 3 comments
Labels
enhancement Functionality that enhances existing features good first issue Good for newcomers

Comments

@Shinigami92
Copy link
Contributor

Shinigami92 commented Aug 27, 2018

Maybe we should change all headers from this

/**
 * Copyright (c) 2015, Yanis Wang <[email protected]>
 * MIT Licensed
 */

to something like this

/**
 * @license
 * MIT Licensed
 *
 * Copyright (c) 2014-2016 Yanis Wang <[email protected]>
 * Copyright (c) 2018 David Dias <[email protected]>
 *
 * Use of this source code is governed by an MIT-style license that can be
 * found in the LICENSE file at https://github.com/thedaviddias/HTMLHint/blob/master/LICENSE.md
 */

or full version

/**
 * @license
 * Copyright (c) 2014-2016 Yanis Wang <[email protected]>
 * Copyright (c) 2018 David Dias <[email protected]>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

http://usejsdoc.org/tags-license.html


I think I need to figure out what works best if you require a module and the JSDoc appears in something like VSCode


Another idea would be to remove all headers and trust the LICENSE.md file in the repository

@thedaviddias
Copy link
Member

The best idea is to remove it, you don't need any header in the files.

@thedaviddias thedaviddias added enhancement Functionality that enhances existing features #status: accepted good first issue Good for newcomers labels Aug 27, 2018
@waldyrious
Copy link
Contributor

I believe the recommended practice is to have a one-line comment with an SPDX license identifier in the source files, just to be 100% clear (that allows the inline licensing info to be both concise and unambiguous). But the LICENSE file at the project root should be sufficient for most cases, yeah.

@thedaviddias
Copy link
Member

@Shinigami92 Can you close the issue?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Functionality that enhances existing features good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants