Add a developer guide to help new contributors get started #3806
Conversation
Signed-off-by: Ijeoma Igboagu <[email protected]>
ijayhub
force-pushed
the
improve-developer-doc
branch
from
3c03571 to
35c91d3
Compare
| 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. | ||
|
|
||
| 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!
I used AI to help rephrase and clarify parts, not to write; I reviewed and edited everything to match the project’s goals.
Happy to adjust the tone or content further if needed.
| - **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. |
There was a problem hiding this comment.
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?
|
|
||
| - 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, make help gives an overview... For instance: make native
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.
Signed-off-by: Ijeoma Igboagu <[email protected]>
Signed-off-by: Ijeoma Igboagu <[email protected]>
Signed-off-by: Ijeoma Igboagu <[email protected]>
This PR adds a simple developer guide to help new contributors understand the project, where to start, and how to contribute to Lima.
It includes:
Quick start steps.
Useful links to the community and documentation.
Let me know if any part needs adjustment.