Skip to content

Relicense under PolyForm Noncommercial, add CI badges and testing docs - #3

Merged
TenOfNine merged 1 commit into
mainfrom
docs/noncommercial-license-and-testing-badges
Aug 10, 2026
Merged

Relicense under PolyForm Noncommercial, add CI badges and testing docs#3
TenOfNine merged 1 commit into
mainfrom
docs/noncommercial-license-and-testing-badges

Conversation

@TenOfNine

@TenOfNine TenOfNine commented Aug 10, 2026

Copy link
Copy Markdown
Owner

Summary

  • Add LICENSE (PolyForm Noncommercial License 1.0.0) — free to use, modify, and self-host for any noncommercial purpose; commercial resale/offering as a paid service requires a separate agreement with the copyright holder. Vendored front-end assets (Bootstrap, jQuery, Chart.js) keep their own original MIT licenses.
  • Add a status badge row to the README (CI, CodeQL, license, .NET version, tests) and a new Testing section documenting the current xUnit results (62/62 passing) and what each CI workflow checks.
  • Add two further CI/CD workflows:
    • codeql.yml — CodeQL static analysis for C#, on every PR/push to main plus a weekly schedule.
    • dependency-review.yml — fails PRs that introduce dependencies with high-severity vulnerability advisories.
  • Bump the technical specification to v1.2 documenting the license change and the two new CI/CD workflows.

Test plan

  • dotnet build -c Release — succeeds, 0 warnings/errors
  • dotnet test -c Release — 62/62 passing
  • CI (ci.yml, codeql.yml, dependency-review.yml) runs green on this PR

Generated by Claude Code

- Add LICENSE (PolyForm Noncommercial 1.0.0) restricting commercial resale
  while permitting free noncommercial use, modification, and self-hosting
- Add CI/license/tests badges to README plus a Testing section documenting
  current xUnit results and what each CI workflow checks
- Add codeql.yml (CodeQL static analysis) and dependency-review.yml
  (vulnerable-dependency check on PRs) as additional CI/CD checks
- Update technical specification to v1.2 with the new licensing and CI/CD
  workflow entries
@github-advanced-security

Copy link
Copy Markdown

You are seeing this message because GitHub Code Scanning has recently been set up for this repository, or this pull request contains the workflow file for the Code Scanning tool.

What Enabling Code Scanning Means:

  • The 'Security' tab will display more code scanning analysis results (e.g., for the default branch).
  • Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results.
  • You will be able to see the analysis results for the pull request's branch on this overview once the scans have completed and the checks have passed.

For more information about GitHub Code Scanning, check out the documentation.

@github-actions

Copy link
Copy Markdown

Dependency Review

The following issues were found:
  • ✅ 0 vulnerable package(s)
  • ✅ 0 package(s) with incompatible licenses
  • ✅ 0 package(s) with invalid SPDX license definitions
  • ⚠️ 2 package(s) with unknown licenses.
See the Details below.

License Issues

.github/workflows/dependency-review.yml

PackageVersionLicenseIssue Type
actions/checkout4.*.*NullUnknown License
actions/dependency-review-action4.*.*NullUnknown License

OpenSSF Scorecard

PackageVersionScoreDetails
actions/actions/checkout 4.*.* 🟢 6.9
Details
CheckScoreReason
Binary-Artifacts🟢 10no binaries found in the repo
Code-Review🟢 10all changesets reviewed
Maintained🟢 1024 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10
Dangerous-Workflow🟢 10no dangerous workflow patterns detected
Token-Permissions⚠️ 0detected GitHub workflow tokens with excessive permissions
CII-Best-Practices⚠️ 0no effort to earn an OpenSSF best practices badge detected
Fuzzing⚠️ 0project is not fuzzed
Packaging⚠️ -1packaging workflow not detected
License🟢 10license file detected
Pinned-Dependencies🟢 3dependency not pinned by hash detected -- score normalized to 3
Signed-Releases⚠️ -1no releases found
Security-Policy🟢 9security policy file detected
SAST🟢 10SAST tool is run on all commits
Branch-Protection🟢 5branch protection is not maximal on development and all release branches
actions/actions/dependency-review-action 4.*.* 🟢 7.7
Details
CheckScoreReason
Code-Review🟢 10all changesets reviewed
Dangerous-Workflow🟢 10no dangerous workflow patterns detected
Maintained🟢 1020 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10
Packaging⚠️ -1packaging workflow not detected
Security-Policy🟢 9security policy file detected
Token-Permissions🟢 9detected GitHub workflow tokens with excessive permissions
Binary-Artifacts🟢 10no binaries found in the repo
CII-Best-Practices⚠️ 0no effort to earn an OpenSSF best practices badge detected
Pinned-Dependencies⚠️ 1dependency not pinned by hash detected -- score normalized to 1
License🟢 10license file detected
Fuzzing⚠️ 0project is not fuzzed
Signed-Releases⚠️ -1no releases found
Branch-Protection🟢 6branch protection is not maximal on development and all release branches
SAST🟢 9SAST tool detected but not run on all commits

Scanned Files

  • .github/workflows/dependency-review.yml

@TenOfNine TenOfNine left a comment

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Checked, looks good/as expected.

@TenOfNine
TenOfNine merged commit d22145c into main Aug 10, 2026
4 of 5 checks passed
@TenOfNine
TenOfNine deleted the docs/noncommercial-license-and-testing-badges branch August 10, 2026 12:36
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.

3 participants