search

maehr / open-research-data-template

GitHub template for FAIR and open research data
https://maehr.github.io/open-research-data-template/
GNU Affero General Public License v3.0
18 stars 1 forks source link

feat: add dual licensing fix #5 #14

Closed maehr closed 4 months ago

maehr commented 4 months ago

Pull request

Proposed changes

Types of changes

Checklist

Summary by CodeRabbit

coderabbitai[bot] commented 4 months ago

Walkthrough

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.

Changes

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.

Assessment against linked issues

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. 🌼📜

Recent Review Details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between be1c9b3a3f4fcf9dd7fa2c6affe7cecff4cef7d3 and 9f68bead43ea9c82796985c8c9259d5304df09cd.
Files selected for processing (1) * README.template.md (1 hunks)
Additional Context Used
LanguageTool (26)
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 [...
Additional comments not posted (2)
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.
--- Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
mtwente commented 4 months ago

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:

Code License Badge Data License Badge

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).

maehr commented 4 months ago

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:

Code License Badge Data License Badge

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?
coderabbitai[bot] commented 4 months ago

[!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!

Analysis chain Once the issue is created, I will provide the URL to the user, confirming the action has been completed.
Scripts executed The following scripts were executed for the analysis: --- Script: ```shell #!/bin/bash # Create a new GitHub issue using the provided template gh issue create --title "🛠️ Request New Feature" --body "Describe what feature you'd like. Pseudo-code, mockups, or screenshots of similar solutions are encouraged!\n\nWhat type of pull request would this be?\n- 'New Feature'\n- 'Enhancement'\n- 'Guide'\n- 'Docs'\n- 'Other'\n\nAny links to similar examples or other references we should review?" --label "feature request" ``` Length of output: 457
maehr commented 4 months ago

@coderabbitai Create one without the label

coderabbitai[bot] commented 4 months ago

[!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!

Analysis chain
Scripts executed The following scripts were executed for the analysis: --- Script: ```shell #!/bin/bash # Create a new GitHub issue using the provided template without the label gh issue create --title "🛠️ Request New Feature" --body "Describe what feature you'd like. Pseudo-code, mockups, or screenshots of similar solutions are encouraged!\n\nWhat type of pull request would this be?\n- 'New Feature'\n- 'Enhancement'\n- 'Guide'\n- 'Docs'\n- 'Other'\n\nAny links to similar examples or other references we should review?" ``` Length of output: 445
coderabbitai[bot] commented 4 months ago

[!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!

Analysis chain
Scripts executed The following scripts were executed for the analysis: --- Script: ```shell #!/bin/bash # Create a new GitHub issue using the provided template without labels gh issue create --title "🛠️ Request New Feature" --body "Describe what feature you'd like. Pseudo-code, mockups, or screenshots of similar solutions are encouraged!\n\nWhat type of pull request would this be?\n- 'New Feature'\n- 'Enhancement'\n- 'Guide'\n- 'Docs'\n- 'Other'\n\nAny links to similar examples or other references we should review?" --label "" ``` Length of output: 456
maehr commented 4 months ago

@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 (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:

Code License Badge Data License Badge

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).

coderabbitai[bot] commented 4 months ago

[!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!

Analysis chain Once the script is executed and the issue is updated, I will inform the user about the completion of the task.
Scripts executed The following scripts were executed for the analysis: --- Script: ```shell #!/bin/bash # Update the GitHub issue with the new feature request for dual badges gh issue edit 17 --body "Feature request for adding two specific license badges to README.md and README.template.md as proposed by @mtwente. The badges are as follows: ![Code License Badge](https://camo.githubusercontent.com/0646922e06dc719330b8808eb9622b14f71e3c242a4831caa5bf31b3bc3de52c/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f636f64652d4150474c2d677265656e) ![Data License Badge](https://camo.githubusercontent.com/cc7368875bd87ece505afcde23ab4386aacf543c011bb864ade3f8643bfb9dd0/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f646174612d43432d2d42595f342e302d677265656e) This change addresses the issue of displaying multiple licenses on GitHub's 'License' tab, which currently only shows one license sorted alphabetically. The addition of these badges to the README files will visually represent the dual licensing directly in the project documentation." ``` Length of output: 964