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 |
|---|---|---|
|
|
@@ -2,3 +2,27 @@ | |
| title: Developers' guide | ||
| weight: 500 | ||
| --- | ||
|
|
||
| Welcome to the Lima Developer Guide! | ||
|
|
||
| Lima is a free tool that helps you run Linux virtual machines, mostly on macOS and Linux. | ||
|
|
||
| Here’s how to get started: | ||
|
|
||
| ## 📌 Quick Start for Contributors | ||
|
|
||
| - **Learn about the code**: Visit [Lima on DeepWiki](https://deepwiki.com/lima-vm/lima) to understand how things are set up. | ||
| - **Know the main folders**: | ||
| - `cmd/` and `pkg/` — contain the main source code. | ||
| - `website/` — contains the documentation website ([lima-vm.io](https://lima-vm.io)). | ||
| - **Read the guide**: Follow the steps in [`CONTRIBUTING.md`](https://github.com/lima-vm/.github/blob/main/CONTRIBUTING.md) to set up everything. | ||
| - **Join the community**: You can ask questions or share ideas through GitHub Issues or Discussions. | ||
|
|
||
| ## 🧠 Tips for First-Time Contributors | ||
|
|
||
| - Start small: fix typos, improve docs, or make code comments easier to understand. | ||
| - Don’t be afraid to ask questions. | ||
| - Use `make` to build or test the project from the command line. | ||
|
There was a problem hiding this comment. There are lots of different targets, There are no targets for testing yet, though. Only for building. Maybe that needs improvement? There was a problem hiding this comment. Thanks @afbjorklund and @alexandear for the detailed feedback. |
||
|
|
||
| We’re happy you’re here. Every little bit of contribution counts! | ||
|
There was a problem hiding this comment. Perhaps these lines are fully generated with an AI agent (seems like ChatGPT). There was a problem hiding this comment. Thanks for the feedback, @alexandear! |
||
|
|
||
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.
This is a redirect, to https://lima-vm.io/docs/community/contributing/ (but use a relative link)
It doesn't really mention how to set up the development environment though, like Git and Go?