-
Notifications
You must be signed in to change notification settings - Fork 0
Add-GPLv3-metadata-and-DCO-docs #7
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| ## Summary | ||
|
|
||
| <!-- What changed and why? --> | ||
|
|
||
| ## Testing | ||
|
|
||
| - [ ] `npm test` | ||
| - [ ] `npm run typecheck` | ||
| - [ ] `npm run build:web` (if web/build files changed) | ||
|
|
||
| ## License and DCO | ||
|
|
||
| - [ ] I agree that this contribution is licensed under GPL-3.0-or-later, the same license as this project. | ||
| - [ ] Every commit in this pull request includes a DCO sign-off (`Signed-off-by:`). Use `git commit -s`, or run `git rebase --signoff` to fix existing commits. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| name: CI | ||
|
|
||
| on: | ||
| pull_request: | ||
| branches: [main] | ||
| push: | ||
| branches: [main] | ||
|
|
||
| concurrency: | ||
| group: ci-${{ github.workflow }}-${{ github.ref }} | ||
| cancel-in-progress: true | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| jobs: | ||
| verify: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | ||
|
|
||
| - name: Setup Node | ||
| uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4 | ||
| with: | ||
| node-version: 20 | ||
| cache: npm | ||
|
|
||
| - name: Install dependencies | ||
| run: npm ci | ||
|
|
||
| - name: Unit tests | ||
| run: npm test | ||
|
|
||
| - name: Typecheck | ||
| run: npm run typecheck | ||
|
|
||
| - name: Build web app | ||
| run: npm run build:web |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| # <subject> (max 72 chars) | ||
| # | ||
| # <optional body> | ||
| # | ||
| # Every commit must include a DCO sign-off for the DCO GitHub App. | ||
| # Use: git commit -s | ||
| # Or add manually: | ||
| # Signed-off-by: Your Name <your.email@example.com> | ||
| # | ||
| # See CONTRIBUTING.md and DCO for details. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| # Contributing to Grillo Project Hub | ||
|
|
||
| Thank you for helping improve Grillo Project Hub. | ||
|
|
||
| ## License | ||
|
|
||
| By contributing to this repository, you agree that your contributions will be | ||
| licensed under the same terms as the project: **GNU General Public License | ||
| v3.0 or later (GPL-3.0-or-later)**. | ||
|
|
||
| See [LICENSE](LICENSE) for the full license text and [COPYING](COPYING) for the | ||
| standard short copyright notice. | ||
|
|
||
| ## Developer Certificate of Origin (DCO) | ||
|
|
||
| This project uses the [Developer Certificate of Origin 1.1](DCO). The | ||
| [DCO GitHub App](https://github.com/apps/dco) checks that every commit in a | ||
| pull request includes a sign-off line. | ||
|
|
||
| Add a sign-off to each commit: | ||
|
|
||
| ```bash | ||
| git commit -s -m "Your commit message" | ||
| ``` | ||
|
|
||
| That appends a line like: | ||
|
|
||
| ```text | ||
| Signed-off-by: Your Name <your.email@example.com> | ||
| ``` | ||
|
|
||
| Use the same name and email as your Git author identity (`git config user.name` | ||
| and `git config user.email`). | ||
|
|
||
| ### Fixing commits that are missing a sign-off | ||
|
|
||
| If DCO fails on an open pull request, amend or rebase your branch so every | ||
| commit is signed off: | ||
|
|
||
| ```bash | ||
| # last commit only | ||
| git commit --amend -s --no-edit | ||
|
|
||
| # every commit on the branch (replace N with commit count) | ||
| git rebase HEAD~N --signoff | ||
| git push --force-with-lease | ||
| ``` | ||
|
|
||
| ## How to contribute | ||
|
|
||
| 1. Fork the repository and create a feature branch from `main`. | ||
| 2. Enable the local commit template so Git reminds you to sign off: | ||
|
|
||
| ```bash | ||
| git config commit.template .gitmessage | ||
| ``` | ||
|
|
||
| 3. Make your changes with tests where behavior changes. | ||
| 4. Commit with `git commit -s` so the DCO check passes. | ||
| 5. Run the local checks before opening a pull request: | ||
|
|
||
| ```bash | ||
| npm install | ||
| npm test | ||
| npm run typecheck | ||
| npm run build:web | ||
| ``` | ||
|
|
||
| 6. Open a pull request against `main` with a clear summary and test notes. | ||
| 7. Wait for CI and required checks (including DCO) to pass before merging. | ||
|
|
||
| Direct pushes to `main` are discouraged; use pull requests so CI and review | ||
| can run first. | ||
|
|
||
| ## Source file notices | ||
|
|
||
| New source files should include the short GPL header from [COPYING](COPYING) | ||
| or this minimal form at the top of the file: | ||
|
|
||
| ```text | ||
| // Grillo Project Hub — Copyright (C) 2026 ZDOSS | ||
| // SPDX-License-Identifier: GPL-3.0-or-later | ||
| ``` | ||
|
|
||
| ## Questions | ||
|
|
||
| Open a GitHub issue for bugs, feature requests, or licensing questions before | ||
| starting large changes. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| Grillo Project Hub | ||
| Copyright (C) 2026 ZDOSS | ||
|
|
||
| This program is free software: you can redistribute it and/or modify | ||
| it under the terms of the GNU General Public License as published by | ||
| the Free Software Foundation, either version 3 of the License, or | ||
| (at your option) any later version. | ||
|
|
||
| This program is distributed in the hope that it will be useful, | ||
| but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| GNU General Public License for more details. | ||
|
|
||
| You should have received a copy of the GNU General Public License | ||
| along with this program. If not, see <https://www.gnu.org/licenses/>. | ||
|
|
||
| The full text of GPLv3 is also available in the LICENSE file at the | ||
| repository root. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| Developer Certificate of Origin | ||
| Version 1.1 | ||
|
|
||
| Copyright (C) 2004, 2006 The Linux Foundation and its contributors. | ||
|
|
||
| Everyone is permitted to copy and distribute verbatim copies of this | ||
| license document, but changing it is not allowed. | ||
|
|
||
|
|
||
| Developer's Certificate of Origin 1.1 | ||
|
|
||
| By making a contribution to this project, I certify that: | ||
|
|
||
| (a) The contribution was created in whole or in part by me and I | ||
| have the right to submit it under the open source license | ||
| indicated in the file; or | ||
|
|
||
| (b) The contribution is based upon previous work that, to the best | ||
| of my knowledge, is covered under an appropriate open source | ||
| license and I have the right under that license to submit that | ||
| work with modifications, whether created in whole or in part | ||
| by me, under the same open source license (unless I am | ||
| permitted to submit under a different license), as indicated | ||
| in the file; or | ||
|
|
||
| (c) The contribution was provided directly to me by some other | ||
| person who certified (a), (b) or (c) and I have not modified | ||
| it. | ||
|
|
||
| (d) I understand and agree that this project and the contribution | ||
| are public and that a record of the contribution (including all | ||
| personal information I submit with it, including my sign-off) is | ||
| maintained indefinitely and may be redistributed consistent with | ||
| this project or the open source license(s) involved. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.