Skip to content

Commit 39bd35c

Browse files
authored
Adds setup and instructions for Github Copilot (#509) (#514)
Signed-off-by: Quetzal Bradley <qbradley@microsoft.com>
1 parent 1fac117 commit 39bd35c

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

.github/copilot-instructions.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
This repository contains hyperlight. Hyperlight is a lightweight Virtual Machine Manager (VMM) designed to be embedded within applications.
1+
This repository contains hyperlight. Hyperlight is a lightweight Virtual Machine Manager (VMM) designed to be embedded within applications.
22
It enables safe execution of untrusted code within micro virtual machines with very low latency and minimal overhead.
33

44
This project uses just as a runner for building, testing etc. Just should already be installed. Most of the code in the repository is written in Rust, with a few files in C.
@@ -20,7 +20,7 @@ just clippy release
2020
If any lints fail you can try to fix them by running the following command for debug failures:
2121

2222
```bash
23-
cargo clippy --fix --all
23+
cargo clippy --fix --all
2424
```
2525
And the following command for release failures:
2626

@@ -36,15 +36,15 @@ If this does not work, you should try and fix the errors and then run the comman
3636
- `just build` - builds the project in debug mode
3737
- `just build release` - builds the project in release mode
3838
- `just guests` - builds the guest library and test guests for both debug and release modes
39-
- test
39+
- test
4040
- `just test` - runs all tests in debug mode
4141
- `just test release` - runs all tests in release mode
4242

43-
**IMPORTANT** You will need to run `just guests` to build the guest library before running the tests.
43+
**IMPORTANT** You will need to run `just guests` to build the guest library before running the tests.
4444

45-
Before pushing your code, make sure to run the following commands to ensure that everything is working correctly make sure all tests pass by running
45+
Before pushing your code, make sure to run the following commands to ensure that everything is working correctly make sure all tests pass by running
4646
```bash
47-
just test-like-ci
47+
just test-like-ci
4848
just test-like-ci release
4949
```
5050

@@ -57,11 +57,11 @@ Maintain the structure and organization of the codebase. Do not introduce new cr
5757
Make sure to write tests for any new code you add. Follow the existing testing patterns in the codebase.
5858
Make sure to fully document any new code you add. Use rustdoc comments and follow guidelines for good documentation.
5959
Make sure that any changes which alter anything documented in the README or the documentation in the docs directory are reflected in the documentation.
60-
Make sure that you label the PRs that you create with the correct labels. You can find details about which labels to use in the documents `docs\github-labels,md`
60+
Make sure that you label the PRs that you create with the correct labels. You can find details about which labels to use in the documents `docs/github-labels.md`.
6161
Make sure that you do not include any large binary files in your PR. If you need to include a large binary file, please discuss it with the team first.
6262
Make sure that you keep commits small and focused. Each commit should represent a single change or addition to the codebase. This will make it easier for reviewers to understand your changes and for you to revert them if necessary.
63-
Make sure that you arrange your commits in a logical order. You can use `git rebase -i` to do this.
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
63+
Make sure that you arrange your commits in a logical order. You can use `git rebase -i` to do this.
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.
6565
Make sure that you do not have any merge commits in your PR.
6666

6767
## Repository Structure
@@ -71,9 +71,9 @@ Make sure that you do not have any merge commits in your PR.
7171
- `Justfile` - contains the just commands for building, testing and running the project
7272
- `fuzz` - contains the fuzzing tests for the project
7373
- `src/hyperlight_common/` - contains the common code shared between the host and guest
74-
- `src/hyperlight_guest/` - contains the hyperlight-guest library code
74+
- `src/hyperlight_guest/` - contains the hyperlight-guest library code
7575
- `src/hyperlight_host/` - contains the hyperlight-host library code
76-
- `src/hyperlight_guest_capi/` - contains the hyperlight-guest C library code
76+
- `src/hyperlight_guest_capi/` - contains the hyperlight-guest C library code
7777
- `src/hyperlight_testing/` - contains the shared code for tests
7878
- `schema/` - contains the flatbuffer schemas for the project
7979
- `tests/` - contains the test guest code for the project in C and Rust

0 commit comments

Comments
 (0)