From 82032ce232eea0a099166e7d3f4c1bc60e5fdcc7 Mon Sep 17 00:00:00 2001 From: Geoff Turk Date: Fri, 4 Sep 2026 16:23:56 +0200 Subject: [PATCH] chore: add Apache-2.0 license and DCO check The vtafarm repositories are going public under the Apache License 2.0. Until now they carried no license at all, which leaves them visible but all-rights-reserved, and nothing verified the Signed-off-by trailer that every commit already carries. - LICENSE: verbatim Apache License 2.0 text. - NOTICE: copyright and attribution to IC3 SOFTWARE. - CONTRIBUTING.md: contributions are licensed under Apache-2.0 per section 5 of the license (no CLA); every commit needs a Developer Certificate of Origin sign-off whose email matches the author. - .github/workflows/dco.yaml: a pull-request check that reads the PR's commits through the API, skips merge commits, and fails on a missing trailer or a sign-off email that matches neither author nor committer. A ruleset on main requires this check. - README.md: License section pointing at the three files. Signed-off-by: Geoff Turk --- .github/workflows/dco.yaml | 39 +++++++ CONTRIBUTING.md | 50 +++++++++ LICENSE | 202 +++++++++++++++++++++++++++++++++++++ NOTICE | 5 + README.md | 5 + 5 files changed, 301 insertions(+) create mode 100644 .github/workflows/dco.yaml create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE create mode 100644 NOTICE diff --git a/.github/workflows/dco.yaml b/.github/workflows/dco.yaml new file mode 100644 index 0000000..d4c5e21 --- /dev/null +++ b/.github/workflows/dco.yaml @@ -0,0 +1,39 @@ +name: DCO +on: + pull_request: +permissions: + contents: read + pull-requests: read +jobs: + check: + name: ✍️ Sign-off + runs-on: ubuntu-latest + steps: + - name: ✍️ Check every commit is signed off + env: + GH_TOKEN: ${{ github.token }} + REPO: ${{ github.repository }} + PR: ${{ github.event.pull_request.number }} + run: | + set -euo pipefail + bad=$(gh api "repos/$REPO/pulls/$PR/commits" --paginate --jq ' + .[] + | select((.parents | length) < 2) + | . as $c + | [ $c.commit.message | split("\n")[] + | select(test("^signed-off-by:"; "i")) + | capture("<(?[^>]+)>\\s*$") | .email | ascii_downcase ] as $signoffs + | ($c.commit.author.email | ascii_downcase) as $author + | ($c.commit.committer.email | ascii_downcase) as $committer + | if (($signoffs | index($author)) != null) or (($signoffs | index($committer)) != null) + then empty + elif ($signoffs | length) == 0 + then "\($c.sha[0:7]) \($c.commit.author.email): no Signed-off-by trailer" + else "\($c.sha[0:7]) \($c.commit.author.email): sign-off \($signoffs | join(", ")) does not match the author or committer email" + end') + if [ -n "$bad" ]; then + printf '%s\n' "$bad" + echo "::error::One or more commits fail the Developer Certificate of Origin check. See CONTRIBUTING.md." + exit 1 + fi + echo "All commits are signed off." diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..61b58b1 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,50 @@ +# Contributing + +Thanks for your interest in VTA Farm. This page covers the two things every contribution needs: +the licence it arrives under, and the sign-off that certifies you may submit it. + +## Licence of contributions + +This project is licensed under the [Apache License 2.0](LICENSE). Section 5 of that licence +provides that any contribution you intentionally submit for inclusion is licensed under the same +terms, without any additional terms or conditions. There is no contributor licence agreement (CLA) +to sign; the licence itself governs contributions. + +## Developer Certificate of Origin + +Every commit must carry a `Signed-off-by` trailer, which certifies that you wrote the change or +otherwise have the right to submit it under the project licence, as set out in the +[Developer Certificate of Origin](https://developercertificate.org). The trailer looks like this: + +```text +Signed-off-by: Your Name +``` + +The email address in the trailer must match the author email of the commit. Git adds the trailer +for you with `git commit -s`, and `git config --global format.signOff true` makes it automatic. +Merge commits are exempt. + +A check named *DCO* runs on every pull request and fails if any commit is missing the trailer or +is signed off with a different email address. Merging into `main` requires that check to pass. + +### If the DCO check fails + +For the most recent commit: + +```bash +git commit --amend -s --no-edit +git push --force-with-lease +``` + +For several commits on your branch: + +```bash +git rebase --signoff origin/main +git push --force-with-lease +``` + +## Pull requests + +1. Branch from `main`. +2. Use a Conventional Commits title: `feat:`, `fix:`, `docs:`, `chore:`, `refactor:`. +3. Keep each pull request focused on one change. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/NOTICE b/NOTICE new file mode 100644 index 0000000..079ff2e --- /dev/null +++ b/NOTICE @@ -0,0 +1,5 @@ +VTA Farm frontend +Copyright 2026 IC3 SOFTWARE + +This product includes software developed at IC3 SOFTWARE +(https://github.com/ic3software). diff --git a/README.md b/README.md index cfc0468..9f3dab2 100644 --- a/README.md +++ b/README.md @@ -57,3 +57,8 @@ pnpm dlx shadcn@latest add ``` Components land in `src/components/ui/`. + +## License + +VTA Farm is licensed under the [Apache License 2.0](LICENSE). See [NOTICE](NOTICE) for attribution. +Contributions are welcome under the terms in [CONTRIBUTING.md](CONTRIBUTING.md).