Closed maehr closed 4 months ago
The update involves a transition in licensing for both software and data components. The software license has been shifted from Apache-2.0 to AGPL-3.0, enhancing the requirements for sharing modifications when the software is run over a network. Additionally, the GNU Affero General Public License version 3.0 has been introduced, emphasizing community cooperation and source code accessibility.
File(s) | Change Summary |
---|---|
CITATION.cff , README.template.md , README.md |
Updated software license from Apache-2.0 to AGPL-3.0. Introduced AGPL-3.0 for software and retained Creative Commons Attribution 4.0 for data. Added details on giving credit and making modifications available under the same license. |
LICENSE.md |
Renamed to LICENSE-CCBY , added requirement for giving credit to original authors and indicating modifications for data usage. |
LICENSE-AGPL |
Added GNU Affero General Public License version 3.0, focusing on sharing, modifying, and distributing software with a requirement to make modifications available under the same license for code usage. |
Objective | Addressed | Explanation |
---|---|---|
Add Dual Licensing: AGPL for Code | β |
ππ In the meadow of code, under the sky so blue,
A change was made, a license anew.
AGPL whispers through the wires,
Sharing and caring, what open source requires.
Hop along, dear friends, let's view,
Code shared freely, for me and you. πΌπ
README.template.md (26)
Near line 15: Loose punctuation mark. Context: ... is organized as follows: - `analysis/`: scripts and notebooks used to analyze t... --- Near line 21: Loose punctuation mark. Context: ...ing notes, project plans, etc.) - `src/`: source code for the data (e.g., scripts... --- Near line 29: Possible missing comma found. Context: ...the data and is part of the products. - TODO All rights and intellectual property is... --- Near line 33: Possible spelling mistake found. Context: ...lease cite as specified in [CITATION.cff](CITATION.cff). The following citation formats are al... --- Near line 33: Possible spelling mistake found. Context: ...ion formats are also available through _Zenodo_: - [BibTeX](https://zenodo.org/record... --- Near line 37: Possible spelling mistake found. Context: ...org/record/ZENODO_RECORD/export/csl) - [DataCite](https://zenodo.org/record/ZENODO_RECOR... --- Near line 39: Possible spelling mistake found. Context: ....org/record/ZENODO_RECORD/export/xd) - [DCAT](https://zenodo.org/record/ZENODO_RECOR... --- Near line 42: Possible spelling mistake found. Context: ...NODO_RECORD/export/schemaorg_jsonld) - [GeoJSON](https://zenodo.org/record/ZENODO_RECOR... --- Near line 43: Possible spelling mistake found. Context: ...record/ZENODO_RECORD/export/geojson) - [MARCXML](https://zenodo.org/record/ZENODO_RECOR... --- Near line 45: Possible spelling mistake found. Context: ...o.org/record/ZENODO_RECORD/export/xm) _Zenodo_ provides an [API (REST & OAI-PMH)](htt... --- Near line 55: Possible typo: you repeated a whitespace Context: ...more people can benefit from it. | Type | Platforms ... --- Near line 55: Possible typo: you repeated a whitespace Context: ... | Platforms | | ------------------------------------... --- Near line 57: Possible typo: you repeated a whitespace Context: ...----------------- | | π¨ **Bug Reports** | [GitHub Issue Tracker](https://github.... --- Near line 57: Possible typo: you repeated a whitespace Context: ...://github.com/USERNAME/REPO_NAME/issues) | | π **Report bad data** ... --- Near line 58: Possible typo: you repeated a whitespace Context: ...ME/issues) | | π **Report bad data** | [GitHub Issue Tracker](https://github.... --- Near line 58: Possible typo: you repeated a whitespace Context: ...://github.com/USERNAME/REPO_NAME/issues) | | π **Docs Issue** ... --- Near line 59: Possible typo: you repeated a whitespace Context: ...PO_NAME/issues) | | π **Docs Issue** | [GitHub Issue Tracker](https://github.... --- Near line 59: Possible typo: you repeated a whitespace Context: ...://github.com/USERNAME/REPO_NAME/issues) | | π **Feature Requests** ... --- Near line 60: Possible typo: you repeated a whitespace Context: ...E/issues) | | π **Feature Requests** | [GitHub Issue Tracker](https://github.... --- Near line 60: Possible typo: you repeated a whitespace Context: ...://github.com/USERNAME/REPO_NAME/issues) | | π‘ **Report a security vulnerability... --- Near line 61: Possible typo: you repeated a whitespace Context: ...ility** | See [SECURITY.md](SECURITY.md) | | π¬ **General Questions** ... --- Near line 62: Possible typo: you repeated a whitespace Context: ... | | π¬ **General Questions** | [GitHub Discussions](https://github.co... --- Near line 78: Possible spelling mistake found. Context: ...s). ## Authors and acknowledgment - **FULLNAME** - _Initial work_ - [USERNAME](https:/... --- Near line 78: Unpaired symbol: β]β seems to be missing Context: ...ment - **FULLNAME** - _Initial work_ - [USERNAME](https://github.com/USERNAME) ... --- Near line 84: Possible spelling mistake found. Context: ...national (CC BY 4.0) License - see the [LICENSE-CCBY](LICENSE-CCBY) file for details. By usi... --- Near line 86: Possible spelling mistake found. Context: ...is repository is released under the GNU Affero General Public License v3.0 - see the [...
README.template.md (2)
`84-84`: The existing comment by mtwente is still valid and accurately describes the licensing for the data. --- `86-86`: The update to the licensing terms for the code is correctly implemented and aligns with the PR objectives.
Small detail: I think the license badge at the top of README.md
(and README.template.md
) should be there twice, too βΒ but I don't think this works automatically with the split licensing, does it? Could be replaced by static badges:
When you click on the "License" tab of the Readme as displayed in a browser, it will also only show one license (apparently sorted in alphabetical order).
Small detail: I think the license badge at the top of
README.md
(andREADME.template.md
) should be there twice, too βΒ but I don't think this works automatically with the split licensing, does it? Could be replaced by static badges:
![]()
When you click on the "License" tab of the Readme as displayed in a browser, it will also only show one license (apparently sorted in alphabetical order).
Thanks for pointing this out. I like the automatic badges but they do indeed not work with multiple licenses... Let's check out, how the badges play together with quarto as most projects using this hopefully will deploy a page instead of the readme.
@coderabbitai can you create an issue using this template
name: π οΈ Request New Feature
description: Let us know what we should add.
labels: ['feature request']
body:
- type: textarea
id: description
attributes:
label: Describe what feature you'd like. Pseudo-code, mockups, or screenshots of similar solutions are encouraged!
- type: dropdown
id: category
attributes:
label: What type of pull request would this be?
options:
- 'New Feature'
- 'Enhancement'
- 'Guide'
- 'Docs'
- 'Other'
- type: textarea
id: references
attributes:
label: Any links to similar examples or other references we should review?
[!TIP] For best results, initiate chat on the files or code changes.
@maehr, it seems there was an issue with creating the GitHub issue due to the label 'feature request' not being found in the repository. Would you like me to try creating the issue again without the label, or would you prefer to add the label to your repository first and then proceed with the issue creation? Please let me know how you'd like to proceed!
@coderabbitai Create one without the label
[!TIP] For best results, initiate chat on the files or code changes.
@maehr, the GitHub issue has been successfully created without the label. You can view and manage the issue here: GitHub Issue #16. If there's anything else you need, feel free to let me know!
[!TIP] For best results, initiate chat on the files or code changes.
@maehr, the GitHub issue has been successfully created without the label. You can view and manage the issue here: GitHub Issue #17. If there's anything else you need, feel free to let me know!
@coderabbitai Sorry for not being sufficiently explicit. Please change the issue such that it becomes a feature request for two badges as proposed by @mtwente
Small detail: I think the license badge at the top of
README.md
(andREADME.template.md
) should be there twice, too βΒ but I don't think this works automatically with the split licensing, does it? Could be replaced by static badges:
![]()
When you click on the "License" tab of the Readme as displayed in a browser, it will also only show one license (apparently sorted in alphabetical order).
[!TIP] For best results, initiate chat on the files or code changes.
@maehr, the GitHub issue has been successfully updated to reflect the feature request for adding two specific license badges as proposed by @mtwente. You can view and manage the updated issue here: GitHub Issue #17. If there's anything else you need, please let me know!
Pull request
Proposed changes
Types of changes
Checklist
Summary by CodeRabbit