Add a developer guide to help new contributors get started #3806
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,17 @@ | ||
|
|
||
| --- | ||
| Title: Developer's Guide | ||
|
|
||
| Weight: 500 | ||
| --- | ||
|
|
||
| Lima is an open-source tool that allows you to run Linux virtual machines on both macOS and Linux. | ||
|
|
||
| ## Quick Start for Contributors | ||
|
There was a problem hiding this comment. This should be consolidated to https://lima-vm.io/docs/community/contributing/ , no ? |
||
|
|
||
| - For more information on the project architecture, visit [Lima on DeepWiki](https://deepwiki.com) | ||
|
There was a problem hiding this comment. It should be noted that this is an AI-generated content and not reviewed by maintainers. Also, the link seems wrong. |
||
| - The main source code is located in the 'cmd/' and 'pkg/' directories. | ||
|
|
||
| - If you wish to contribute, please see [CONTRIBUTING.md](../../../../.github/CONTRIBUTING.md). | ||
|
There was a problem hiding this comment. |
||
| - Have any questions or ideas? To share them, create a GitHub issue or a discussion. | ||
| - Run the'make help' command in your terminal to see what other test commands you can use. | ||
|
There was a problem hiding this comment.
See https://lima-vm.io/docs/dev/testing/ for testing. |
||
| - For additional information on the documentation, please visit ([lima-vm.io](https://lima-vm.io) | ||
|
There was a problem hiding this comment. A visitor is already visiting this site, no? |
||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think you have to duplicate the project overview here.
Also, Lima works on other host OS too.