Add copyright headers along with Furo license #464
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Eric-Arellano
changed the title
javabster
reviewed
Jul 6, 2023
CONTRIBUTING.md
Outdated
| {#- This file is vendored from Furo. When adding custom Qiskit code, surround it with | ||
| `QISKIT CHANGE: start` and `QISKIT CHANGE: end` Jinja-style comments. -#} | ||
| {#- | ||
| This file is vendored from Furo by Pradyun Gedam, used under the MIT license. |
There was a problem hiding this comment.
should we put their github handle not just their name?
There was a problem hiding this comment.
The LICENSE uses their official name and never mentions their GitHub handle, so I think this is the safer bet.
| @@ -1,3 +1,16 @@ | |||
| /* This code is part of Qiskit. | |||
There was a problem hiding this comment.
I think there has been some discussion recently about the statement that this code is part of Qiskit, and maybe it's better to say part of the Qiskit Ecosystem or something. I'm not sure what the decision was and I can't find where I saw the conversation. Maybe @1ucian0 can weigh in?
I'm happy to keep it as is for now so long as we update it to the correct format when we can.
There was a problem hiding this comment.
We are usually going with "This code is a Qiskit project", to distinguish it from the message that Qiskit has.
Eric-Arellano
added a commit
to Eric-Arellano/qiskit_sphinx_theme
that referenced
this pull request
Jul 6, 2023
## Adds Furo license It's extra safe to do this because we vendor about 6 files from Furo. We use the prior art of Pytorch of including the license directly in `LICENSE` at the bottom. Pytorch is also an MIT license and we substantially vendored it, so it's a similar setup. ## Fixes LICENSE inclusion The switch to `pyproject.toml` accidentally changed us including the LICENSE file to instead have the text `Apache 2`. ## Adds copyright file headers We should have been doing this from the start because Qiskit projects are expected to put copyright headers on every file. This becomes especially useful if we more substantially vendor Furo code in Qiskit#463 to make clear what is what. All files that are originally written by Qiskit contributors use the standard Apache 2 license we already use in this project. Meanwhile, files that are vendored from Furo now use this standard notice: > This file is vendored from Furo (created by Pradyun Gedam) and used under the MIT license. Even though the MIT license does not require file headers, and Furo itself does not use it, it is a good practice to make clear what originally comes from Furo. ## Also renames `search_sidebar.html` This file is vendored from Furo, but we had it under `custom_templates/search_sidebar.html` rather than the original `sidebar/search.html`. This PR renames the file so that we more properly attribute Furo and the MIT license.
Eric-Arellano
added a commit
that referenced
this pull request
Jul 6, 2023
…467) ## Adds Furo license It's extra safe to do this because we vendor about 6 files from Furo. We use the prior art of Pytorch of including the license directly in `LICENSE` at the bottom. Pytorch is also an MIT license and we substantially vendored it, so it's a similar setup. ## Fixes LICENSE inclusion The switch to `pyproject.toml` accidentally changed us including the LICENSE file to instead have the text `Apache 2`. ## Adds copyright file headers We should have been doing this from the start because Qiskit projects are expected to put copyright headers on every file. This becomes especially useful if we more substantially vendor Furo code in #463 to make clear what is what. All files that are originally written by Qiskit contributors use the standard Apache 2 license we already use in this project. Meanwhile, files that are vendored from Furo now use this standard notice: > This file is vendored from Furo (created by Pradyun Gedam) and used under the MIT license. Even though the MIT license does not require file headers, and Furo itself does not use it, it is a good practice to make clear what originally comes from Furo. ## Also renames `search_sidebar.html` This file is vendored from Furo, but we had it under `custom_templates/search_sidebar.html` rather than the original `sidebar/search.html`. This PR renames the file so that we more properly attribute Furo and the MIT license.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds Furo license
It's extra safe to do this because we vendor about 6 files from Furo.
We use the prior art of Pytorch of including the license directly in
LICENSEat the bottom. Pytorch is also an MIT license and we substantially vendored it, so it's a similar setup.Fixes LICENSE inclusion
The switch to
pyproject.tomlaccidentally changed us including the LICENSE file to instead have the textApache 2.Adds copyright file headers
We should have been doing this from the start because Qiskit projects are expected to put copyright headers on every file. This becomes especially useful if we more substantially vendor Furo code in #463 to make clear what is what.
All files that are originally written by Qiskit contributors use the standard Apache 2 license we already use in this project.
Meanwhile, files that are vendored from Furo now use this standard notice:
Even though the MIT license does not require file headers, and Furo itself does not use it, it is a good practice to make clear what originally comes from Furo.
Also renames
search_sidebar.htmlThis file is vendored from Furo, but we had it under
custom_templates/search_sidebar.htmlrather than the originalsidebar/search.html. This PR renames the file so that we more properly attribute Furo and the MIT license.