Skip to content

docs: add MIT licence and ASD ISM data licence note - #140

Merged
jusso-dev merged 1 commit into
mainfrom
pa4/ismsearch-mit-licence
Nov 21, 2026
Merged

jusso-dev merged 1 commit into
mainfrom
pa4/ismsearch-mit-licence

Conversation

@jusso-dev

@jusso-dev jusso-dev commented Nov 21, 2026 •

Copy link
Copy Markdown
Owner

Summary

  • Add a root LICENSE file with the MIT Licence (Copyright (c) 2026 Justin Middler).
  • Add "license": "MIT" to package.json.
  • Add a Licence section to README.md covering the MIT Licence for the repository's source code and noting that the synced ASD ISM data and ACSC alerts and advisories remain under ASD's Creative Commons Attribution 4.0 International (CC BY 4.0) terms per https://www.cyber.gov.au/copyright (© Commonwealth of Australia 2026).

Verification

  • Verified package.json parses cleanly with "license": "MIT".
  • Verified live ASD copyright terms at https://www.cyber.gov.au/copyright and the AustralianCyberSecurityCentre/ism-oscal README.
  • Waiting on CI (Lint, typecheck, test and build and Docker build and smoke test).

Summary by CodeRabbit

  • Documentation
    • Added licensing information for the repository’s source code and specified the attribution and terms for sourced data.
    • Published the MIT License, including its copyright notice and warranty disclaimer.

@coderabbitai

coderabbitai Bot commented Nov 21, 2026 •

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The repository adds an MIT license, sets the package license metadata to MIT, and documents the licensing and attribution of specified data in the README.

Changes: License declarations

Layer / File(s) Summary
License terms and scope
LICENSE, package.json, README.md
The repository adds MIT license terms and package metadata. The README distinguishes MIT-licensed source code from specified data attributed to ASD under CC BY 4.0, with stated exclusions and a link to the full copyright terms.

Estimated code review effort: 1 (Trivial) | ~4 minutes

Change: Other

Merge Risk: Minimal · up to e8b40

This change adds MIT licence terms and package metadata, and documents that the synced ASD data keeps its own CC BY 4.0 licence. It has no runtime effect and no actionable merge risk.

Pre-merge checks: Passed 4

Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title "docs: add MIT licence and ASD ISM data licence note" matches the main change in the changeset. The PR adds a root LICENSE file with the MIT License, sets "license": "MIT" in package.json, a…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Title check

Explanation

The title "docs: add MIT licence and ASD ISM data licence note" matches the main change in the changeset. The PR adds a root LICENSE file with the MIT License, sets "license": "MIT" in package.json, and adds a Licence section to README.md. That section explains that ASD ISM data and ACSC alerts in data/ remain under CC BY 4.0. The title names both the code license and the data licence note, so it covers the primary change.

Finishing Touches

Generate unit tests (beta)

  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 84d9cbb1-eade-4a06-8340-c78eaa0bbc41
Commits

Reviewing files that changed from the base of the PR and between c4e72bf and e8b403e.

Files selected for processing: 3

  • LICENSE
  • README.md
  • package.json

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

@jusso-dev
jusso-dev merged commit 3eb862c into main Nov 21, 2026
6 checks passed
@jusso-dev
jusso-dev deleted the pa4/ismsearch-mit-licence branch November 21, 2026 12:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant