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

add copyright notices to all files #154

Closed
Tracked by #114
MCWertGaming opened this issue Dec 6, 2021 · 4 comments
Closed
Tracked by #114

add copyright notices to all files #154

MCWertGaming opened this issue Dec 6, 2021 · 4 comments
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@MCWertGaming
Copy link
Collaborator

MCWertGaming commented Dec 6, 2021

I think we should add small copyright headers to the header files. Something like:

/* =================
 * CPP-Terminal
 * A small library for controling modern terminals
 * (c) 2021 Ondrey Certik
 * /
@MCWertGaming MCWertGaming mentioned this issue Dec 6, 2021
42 tasks
@MCWertGaming MCWertGaming added this to To do in CPP-Terminal Dec 6, 2021
@MCWertGaming MCWertGaming self-assigned this Dec 6, 2021
@MCWertGaming MCWertGaming added the enhancement New feature or request label Dec 6, 2021
@MCWertGaming MCWertGaming added this to the V1.0.0 milestone Dec 6, 2021
@MCWertGaming MCWertGaming moved this from To do to V1.0.0 in CPP-Terminal Dec 9, 2021
@flagarde
Copy link
Collaborator

flagarde commented Sep 28, 2023

Hi @certik , I would like to solve this issue and for this would like to know your opinion about some change.

I found auto-check and auto adding copyright for source code using pre-commit, this will simplicy a lot the problem

It seems we can use this too : https://reuse.software/faq/ that means

  1. Move the MIT license inside LICENSES (It seems that the one you choose for cpp-terminal)
  2. Keep LICENSE but only copy verbatim the MIT license and move the others to LICENSES/folder
    For now github is not able to detect the project is MIT because of the copyright file being copy pasted in LICENSE. This avois the project to be found when searching project with MIT license
  3. use pre-commit to add the copyright

How do you feel about this move ? Meanwhile I added the pre-commit check to avoid file without license infos (the infos are added automatically) #298

@certik
Copy link
Collaborator

certik commented Sep 29, 2023

I am fine with LICENSE / LICENSES I think. I think it's fine to just use one file, but if you feel strongly you prefer two, you can.

I would not put any copyright into files. I think it's not worth the hassle. I would definitely not put names, such as mine, into files, as I think it discourages others to contribute, as they might naturally think that the person listed "owns" the file, while that is not the case.

@flagarde
Copy link
Collaborator

flagarde commented Sep 29, 2023

I understand your concerns, however some companies or institutions are very picky about copyright stuffs (even if the license are compatibles) and as such ask files to have copyright in it to perform automatic checks etcetc. I discovered this when some people asked me for a part of some code I wrote (and I would definitivelly think anyone would have thought it would be in public domain given the simplicity of it). That why The copyright intro is very short :

/* cpp-terminal
* C++ library for writing multiplatform terminal applications.
*
* SPDX-FileCopyrightText: 2019-2023 Ondřej Čertík
*
* SPDX-License-Identifier: MIT
* /

If you don't want to have your name I think it's fine to put the organization name jupyter-xeus. It still very nice to know from where the file comes from if some people want to contribute to the development. Sometimes project includes a lot of libraries and it can be difficult to kno where the file comes from.

Then there is a pre-commit check that add directly the copyright for you so the process is quite transparent to the programmer. the pre-commit check if there is not copyright and if so copy paste the .LICENSE into the source file (This is how I added the license in #298)

@certik
Copy link
Collaborator

certik commented Sep 29, 2023

Just put copyright as "cpp-terminal". I would not do it, but if you insist, you can put the short header in each file.

@flagarde flagarde closed this as completed Oct 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: Done
Development

No branches or pull requests

3 participants