A good place to start is the documentation website.
You can also check out Unikraft's docs
repo and build your own version of the site using the information from the README.md
.
We also recommend taking a look into the Unikraft Summer of Code sessions. If you fancy some live demos, check out Unikraft's Youtube channel.
You can even reach out to community members on discord. There you can discuss your doubts as well as ask questions; the community is always ready and willing to help.
Your mentors are the people you will interact with the most during your project; your guides and the ones that will solidify your integration into the organization. They are also the people that will pass/fail you, so communicating with them not only regarding your issues, but your success too, should be on your TODO list.
They are key stages in your project.They require feedback from both the mentor and the mentee and they determine the status of your project; they also represent a great way for the mentor to decide whether your work will end successfully, therefore (potentially) integrating it.
As stated earlier, both evaluations are a pass/fail from the mentors, so mark the dates in your calendar. They are important!
As the name suggests, you should get to know the people you'll work with, the maintainers, the core, people that previously built the part of the Unikraft project you're working on.
You should, also, (if you haven't already), get accustomed to building and running Unikraft images and come up with a roadmap for the 12+ weeks that you'll have for your idea.
We strongly suggest you attend the Weekly Community Gatherings, formal and informal meetings where we discuss ideas, issues, PRs and other fun stuff.
Shy to even attend? Read the meeting notes and get your courage up!
Theoretically, you can apply without making a contribution, however, we believe that having even a small contribution proves that you are, indeed, not only ready, but willing to contribute to open source code.
For ideas, visit the issue page for core Unikraft and external libraries, such as newlib, lwip, or musl.
We've marked some items with the good first issue
and kind/hackathon
labels to make things easier for you.
Take a look into the docs repository as well, there's always work to be done when documenting a project of Unikraft's size.
Feeling lucky? Try fixing some build warnings. There's plenty of them, waiting just for you!
If you have a project in mind, you are welcome to discuss it with the community members. However, the project needs to be approved by the maintainer members.
How to perfectly kraft1 my proposal?
-
Start looking into the organization way before the Contributor Proposal Period, do not wait for the last week to start the investigation process.
-
Take a good look at the
ideas.md
file, choose a topic based on your current knowledge and begin browsing the web. -
Join the discord server and ask questions! It's extremely important to be as active as possible.
-
Read the
README.md
for the year you are applying in. It contains critical information regarding the whole process, especially the proposal template. -
Write your proposal. Get feedback from the community.