Skip to content

Commit 1fac117

Browse files
authored
Update copilot-instructions (#511)
Signed-off-by: Simon Davies <[email protected]>
1 parent a95a0f5 commit 1fac117

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

.github/copilot-instructions.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ If this does not work, you should try and fix the errors and then run the comman
4040
- `just test` - runs all tests in debug mode
4141
- `just test release` - runs all tests in release mode
4242

43-
Note that if any guest code has changed, you will need to run `just guests` to build the guest library, before running the tests, if the test fail make sure to run `just guests` again to build the guest library, before running the tests again.
43+
**IMPORTANT** You will need to run `just guests` to build the guest library before running the tests.
4444

4545
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
@@ -50,17 +50,25 @@ just test-like-ci release
5050

5151
## Key Instructions
5252

53+
**IMPORTANT**: Please make sure to follow these instructions when making changes to the codebase. If you cannot follow these instructions, please discuss it with the team first.
54+
5355
Follow best practices and idioms for writing Rust code.
5456
Maintain the structure and organization of the codebase. Do not introduce new crates or dependencies without discussing them first.
5557
Make sure to write tests for any new code you add. Follow the existing testing patterns in the codebase.
5658
Make sure to fully document any new code you add. Use rustdoc comments and follow guidelines for good documentation.
5759
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`
61+
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.
62+
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
65+
Make sure that you do not have any merge commits in your PR.
5866

5967
## Repository Structure
6068
- `dev/` - contains development scripts and tools
6169
- `src/` - contains the source code for the project
62-
.editorconfig - contains the editor config for the project you should use this to configure your editor to use the same settings as the rest of the projec
63-
- Justfile - contains the just commands for building, testing and running the project
70+
- `.editorconfig` - contains the editor config for the project you should use this to configure your editor to use the same settings as the rest of the project
71+
- `Justfile` - contains the just commands for building, testing and running the project
6472
- `fuzz` - contains the fuzzing tests for the project
6573
- `src/hyperlight_common/` - contains the common code shared between the host and guest
6674
- `src/hyperlight_guest/` - contains the hyperlight-guest library code

0 commit comments

Comments
 (0)