You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/copilot-instructions.md
+1-2Lines changed: 1 addition & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -63,8 +63,6 @@ Make sure that you keep commits small and focused. Each commit should represent
63
63
Make sure that you arrange your commits in a logical order. You can use `git rebase -i` to do this.
64
64
If you update your PR branch with new commits, make sure to rebase your branch on top of the main branch. This will help keep the commit history clean and make it easier to review your changes.
65
65
Make sure that you do not have any merge commits in your PR.
66
-
If when running tests you receive an Error like this "Error("No Hypervisor was found for Sandbox, Hypervisor Handler Message Receive Timedout")" then the real error is the string inside the brackets before the comma, so in this example
67
-
the error is "No Hypervisor was found for Sandbox".
68
66
If you see the error "No Hypervisor was found for Sandbox" then you if you are running on Linux you should check to see if there is a device called "kvm" or "mshv" in `/dev` and if it is present you should also check to see if you have rw access to it. You should ensure that you output the results of these checks for diagnostic purposes.
69
67
This repository requires commits to be signed you should ensure that any commits that you create are done with `commit.gpgsign=true`. Also commits should also be signed with the `--signoff` option to comply with the DCO requirement.
70
68
@@ -76,6 +74,7 @@ This repository requires commits to be signed you should ensure that any commits
76
74
-`fuzz` - contains the fuzzing tests for the project
77
75
-`src/hyperlight_common/` - contains the common code shared between the host and guest
78
76
-`src/hyperlight_guest/` - contains the hyperlight-guest library code
77
+
-`src/hyperlight_guest_bin/` - contains the hyperlight-guest-bin library code
79
78
-`src/hyperlight_host/` - contains the hyperlight-host library code
80
79
-`src/hyperlight_guest_capi/` - contains the hyperlight-guest C library code
81
80
-`src/hyperlight_testing/` - contains the shared code for tests
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+38-7Lines changed: 38 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ This project welcomes contributions. Most contributions require you to signoff o
4
4
the Developer Certificate of Origin (DCO). When you submit a pull request, a DCO-bot will automatically determine
5
5
whether you need to provide signoff for your commit. Please follow the instructions provided by DCO-bot, as pull
6
6
requests cannot be merged until the author(s) have provided signoff to fulfill the DCO requirement.
7
-
You may find more information on the DCO requirements [below](#developer-certificate-of-origin-signing-your-work).
7
+
You may find more information on the DCO requirements [below](#developer-certificate-of-origin-and-gpg-signing).
8
8
9
9
## Issues
10
10
@@ -31,20 +31,28 @@ All contributions come through pull requests. To submit a proposed change, we re
31
31
- Code changes require tests
32
32
- Make sure to run the linters to check and format the code
33
33
4. Update relevant documentation for the change
34
-
5. Commit with [DCO sign-off](#developer-certificate-of-origin-signing-your-work) and open a PR
34
+
5. Commit with [DCO sign-off](#developer-certificate-of-origin-and-gpg-signing) and open a PR
35
35
6. Wait for the CI process to finish and make sure all checks are green
36
36
7. A maintainer of the project will be assigned, and you can expect a review within a few days
37
37
38
38
#### Use work-in-progress PRs for early feedback
39
39
40
40
A good way to communicate before investing too much time is to create a "Work-in-progress" PR and share it with your reviewers. The standard way of doing this is to add a "[WIP]" prefix in your PR's title and open the pull request as a draft.
41
41
42
-
### Developer Certificate of Origin: Signing your work
42
+
### Developer Certificate of Origin and GPG Signing
43
43
44
44
#### Every commit needs to be signed
45
45
46
+
This project requires two types of signatures on all commits:
47
+
48
+
1.**Developer Certificate of Origin (DCO) Sign-off**: A text attestation that you have the right to submit the code
49
+
2.**GPG Signature**: A cryptographic signature verifying your identity
50
+
51
+
**For DCO Sign-offs:**
52
+
46
53
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. Here is the full text of the [DCO](https://developercertificate.org/), reformatted for readability:
47
-
```
54
+
55
+
```text
48
56
By making a contribution to this project, I certify that:
49
57
50
58
(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
@@ -70,18 +78,41 @@ Git even has a `-s` command line option to append this automatically to your com
70
78
git commit -s -m 'This is my commit message'
71
79
```
72
80
73
-
Each Pull Request is checked whether or not commits in a Pull Request do contain a valid Signed-off-by line.
81
+
**For GPG Signatures:**
82
+
83
+
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).
84
+
85
+
Quick setup:
74
86
75
-
#### I didn't sign my commit, now what?!
87
+
```sh
88
+
git config --global user.signingkey YOUR_KEY_ID
89
+
git config --global commit.gpgsign true
90
+
```
91
+
92
+
**For both DCO sign-off and GPG signature in one command:**
93
+
94
+
```sh
95
+
git commit -S -s -m 'This is my signed and signed-off commit message'
96
+
```
97
+
98
+
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).
99
+
100
+
Each Pull Request is checked to ensure all commits contain valid DCO sign-offs and GPG signatures.
101
+
102
+
#### I didn't sign my commit, now what?
76
103
77
104
No worries - You can easily replay your changes, sign them and force push them!
78
105
106
+
**For adding both DCO sign-off and GPG signature:**
For more 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).
0 commit comments