Address review feedback: update copyright year to 2025, simplify docs, use just in CI, remove markdownlint config

- Remove .markdownlint.json file as it wasn't being used
- Update copyright year from 2024 to 2025 in license header check script and all files with license headers
- Simplify docs/commit-signing.md to remove duplication and reference GitHub's documentation
- Update CONTRIBUTING.md to reference GitHub docs instead of duplicating GPG setup instructions
- Update CI workflow to use `just check-license-headers` for consistency

Co-authored-by: jsturtevant <[email protected]>

Author: Copilot

.github/workflows/ValidatePullRequest.yml

@@ -73,7 +73,7 @@ jobs:
     steps:
     - uses: actions/checkout@v4
     - name: Check License Headers
-      run: ./dev/check-license-headers.sh
+      run: just check-license-headers
 
   # Gate PR merges on this specific "join-job" which requires all other
   # jobs to run first. We need this job since we cannot gate on particular jobs

.markdownlint.json

@@ -80,26 +80,20 @@ git commit -s -m 'This is my commit message'
 
 **For GPG Signatures:**
 
-GPG signatures verify the identity of the committer. To set up GPG signing:
+GPG signatures verify the identity of the committer. For detailed setup instructions, see GitHub's documentation on [signing commits](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits).
 
-1. Generate a GPG key and configure Git to use it:
+Quick setup:
 
-   ```sh
-   git config --global user.signingkey YOUR_KEY_ID
-   git config --global commit.gpgsign true
-   ```
-
-2. Sign commits with the `-S` flag (or rely on the automatic signing from the above configuration):
-
-   ```sh
-   git commit -S -m 'This is my signed commit message'
-   ```
+```sh
+git config --global user.signingkey YOUR_KEY_ID
+git config --global commit.gpgsign true
+```
 
-3. For both DCO sign-off and GPG signature in one command:
+**For both DCO sign-off and GPG signature in one command:**
 
-   ```sh
-   git commit -S -s -m 'This is my signed and signed-off commit message'
-   ```
+```sh
+git commit -S -s -m 'This is my signed and signed-off commit message'
+```
 
 For detailed instructions on setting up both signature types, see [docs/commit-signing.md](./docs/commit-signing.md).
 
@@ -117,16 +111,6 @@ git commit --amend --no-edit -S -s
 git push --force-with-lease <remote-name> <branch-name>
 ```
 
-**For fixing multiple commits:**
-
-```sh
-git rebase -i HEAD~n  # Replace n with the number of commits to fix
-# Change 'pick' to 'edit' for each commit
-# For each commit:
-git commit --amend --no-edit -S -s
-git rebase --continue
-```
-
 For more detailed instructions on fixing commits, see [docs/commit-signing.md](./docs/commit-signing.md).
 
 ### Rust Analyzer

CONTRIBUTING.md

@@ -10,7 +10,7 @@ LICENSE_PATTERN="Copyright .* The Hyperlight Authors..*Licensed under the Apache
 
 # Define the full license header for files that need it
 LICENSE_HEADER='/*
-Copyright 2024 The Hyperlight Authors.
+Copyright 2025 The Hyperlight Authors.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

dev/check-license-headers.sh

@@ -1,164 +1,59 @@
 # Commit Signing Requirements
 
-This document explains how to ensure your commits comply with both the Developer Certificate of Origin (DCO) requirements and GPG signing requirements for this project.
+This document explains the commit signing requirements for this project.
 
-## What is the DCO?
-
-The Developer Certificate of Origin (DCO) is a lightweight way for contributors to certify that they wrote or otherwise have the right to submit the code they are contributing to the project. See the full text in the [CONTRIBUTING.md](../CONTRIBUTING.md#developer-certificate-of-origin-signing-your-work) file.
-
-## Two Required Signature Types
+## Required Signatures
 
 All commits to this repository must have two types of signatures:
 
 1. **DCO Sign-off**: A `Signed-off-by` line in the commit message
 2. **GPG Signature**: A cryptographic signature verifying the committer's identity
 
-## Adding DCO Sign-offs to Commits
-
-All commits must include a `Signed-off-by` line in the commit message. This line certifies that you have the right to submit your contribution under the project's license.
+## DCO Sign-off
 
-### Using the -s Flag
-
-The simplest way to add a sign-off to your commits is to use the `-s` flag with the `git commit` command:
+Add a DCO sign-off to your commits using the `-s` flag:
 
 ```sh
 git commit -s -m "Your commit message"
 ```
 
-This will automatically add a `Signed-off-by` line with your name and email to the commit message.
-
-### Configuring Git for Automatic Sign-offs
-
-You can configure Git to automatically add sign-offs to all your commits:
+For automatic sign-offs on all commits:
 
 ```sh
 git config --global commit.signoff true
 ```
 
-Alternatively, you can create a Git alias for creating signed-off commits:
-
-```sh
-git config --global alias.cs 'commit -s'
-```
-
-Then use `git cs` instead of `git commit` to create commits with sign-offs.
-
-## GPG Signing Your Commits
-
-In addition to DCO sign-offs, all commits must be GPG signed to verify your identity.
-
-### Setting Up GPG
-
-1. If you don't have a GPG key, generate one:
-
-   ```sh
-   gpg --full-generate-key
-   ```
-   
-   Choose RSA and RSA, 4096 bits, and an expiration date of your preference.
-
-2. List your keys to get the ID:
-
-   ```sh
-   gpg --list-secret-keys --keyid-format=long
-   ```
-   
-   Look for the line starting with "sec" and note the key ID after the "/".
-
-3. Configure Git to use your GPG key:
-
-   ```sh
-   git config --global user.signingkey YOUR_KEY_ID
-   ```
-   
-   Replace YOUR_KEY_ID with your actual GPG key ID.
-
-4. Configure Git to sign commits automatically:
-
-   ```sh
-   git config --global commit.gpgsign true
-   ```
+## GPG Signing
 
-### Creating GPG Signed Commits
+For detailed instructions on setting up GPG signing, see [GitHub's documentation on signing commits](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits).
 
-With automatic signing enabled, normal commit commands will create signed commits. You can also explicitly sign with:
+To enable automatic GPG signing:
 
 ```sh
-git commit -S -m "Your commit message"
+git config --global user.signingkey YOUR_KEY_ID
+git config --global commit.gpgsign true
 ```
 
-To create a commit with both GPG signature and DCO sign-off:
+## Both Signatures Together
+
+To create a commit with both DCO sign-off and GPG signature:
 
 ```sh
 git commit -S -s -m "Your commit message"
 ```
 
-### Adding Your GPG Key to GitHub
-
-1. Export your public key:
-
-   ```sh
-   gpg --armor --export YOUR_KEY_ID
-   ```
-
-2. Copy the output and add it to your GitHub account under Settings > SSH and GPG keys.
-
-## Adding Both Signatures to Existing Commits
-
-If you forgot to sign your commits, you can fix them:
+## Fixing Missing Signatures
 
-### For the Last Commit
+To add both signatures to your last commit:
 
 ```sh
 git commit --amend --no-edit -S -s
 ```
 
-### For Multiple Commits
-
-For adding both DCO sign-offs and GPG signatures to a range of commits, use interactive rebase:
-
-1. Start the rebase:
-
-   ```sh
-   git rebase -i HEAD~n
-   ```
-   
-   Replace `n` with the number of commits you want to sign.
-
-2. In the editor, change `pick` to `edit` for each commit.
-
-3. For each commit that opens during the rebase:
-
-   ```sh
-   git commit --amend --no-edit -S -s
-   git rebase --continue
-   ```
-
-Alternatively, for adding just DCO sign-offs to multiple commits:
+For multiple commits, use:
 
 ```sh
-git rebase --signoff HEAD~n
+git rebase --signoff HEAD~n  # Adds DCO sign-offs
 ```
 
-## Verification
-
-The project uses automated checks to verify that all commits include both the required DCO sign-off and GPG signature. If you receive a signature verification failure notification, please follow the instructions above to add the required signatures.
-
-## Troubleshooting
-
-### GPG Signing Issues
-
-If you encounter issues with GPG signing:
-
-- Ensure your GPG key is properly generated and configured with Git
-- Set the `GPG_TTY` environment variable: `export GPG_TTY=$(tty)`
-- For Git GUI tools, you may need to configure GPG agent
-- On Windows, you might need to specify the full path to gpg.exe
-
-### DCO Sign-off Issues
-
-If you encounter issues with DCO sign-offs:
-
-- Ensure your Git user name and email are correctly configured
-- Check that the commit author email matches your configured email
-- For commits created through GitHub's web interface, you'll need to add the sign-off manually in the commit message
+Then manually add GPG signatures as needed during an interactive rebase.

docs/commit-signing.md

@@ -1,5 +1,5 @@
 /*
-Copyright 2024 The Hyperlight Authors.
+Copyright 2025 The Hyperlight Authors.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

src/hyperlight_common/src/outb.rs

@@ -1,5 +1,5 @@
 /*
-Copyright 2024 The Hyperlight Authors.
+Copyright 2025 The Hyperlight Authors.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

src/hyperlight_guest/src/exceptions/idtr.rs

@@ -1,5 +1,5 @@
 /*
-Copyright 2024 The Hyperlight Authors.
+Copyright 2025 The Hyperlight Authors.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

src/hyperlight_guest_capi/build.rs

@@ -1,5 +1,5 @@
 /*
-Copyright 2024 The Hyperlight Authors.
+Copyright 2025 The Hyperlight Authors.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

src/hyperlight_guest_capi/src/dispatch.rs

@@ -1,5 +1,5 @@
 /*
-Copyright 2024 The Hyperlight Authors.
+Copyright 2025 The Hyperlight Authors.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.