Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add KraftKit contributing page #380

Merged
merged 2 commits into from
Mar 2, 2024

Conversation

LucaSeri
Copy link
Contributor

@LucaSeri LucaSeri commented Mar 2, 2024

The KraftKit contributing page has the same format as the Unikraft core contributing page, which has been modified to reflect the conventions used in the KraftKit development.

GitHub-fixes: #370

Signed-off-by: Luca Seritan <luca.seritan@gmail.com>
@LucaSeri LucaSeri force-pushed the kraft-contributing branch 2 times, most recently from 26c2f15 to dd0a81b Compare March 2, 2024 09:49
@razvand razvand self-requested a review March 2, 2024 10:03
@razvand razvand self-assigned this Mar 2, 2024
@razvand razvand requested review from StefanJum and removed request for razvand March 2, 2024 10:03
Copy link
Member

@StefanJum StefanJum left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@LucaSeri you need to update the sidebar for this page to show up. See this for reference.

LE: nvm, the entry is already there, sorry.

Copy link
Member

@StefanJum StefanJum left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See the comments. Also add a link somewhere to some go coding conventions, I assume there must be a list of what go fmt checks for somewhere.

content/docs/contributing/kraftkit.mdx Outdated Show resolved Hide resolved
content/docs/contributing/kraftkit.mdx Outdated Show resolved Hide resolved
content/docs/contributing/kraftkit.mdx Outdated Show resolved Hide resolved
content/docs/contributing/kraftkit.mdx Outdated Show resolved Hide resolved
This page is largely based on the Unikraft core
contributing page and contains details about the
conventions used in KraftKit.

Signed-off-by: Luca Seritan <luca.seritan@gmail.com>
@LucaSeri
Copy link
Contributor Author

LucaSeri commented Mar 2, 2024

Thanks for the review @StefanJum, I added your suggested changes.

Also add a link somewhere to some go coding conventions, I assume there must be a list of what go fmt checks for somewhere.

I linked gofumpt, their readme provides a bunch of examples about the rules, please check if you think that's enough.

@LucaSeri LucaSeri requested a review from StefanJum March 2, 2024 11:28
Copy link
Member

@StefanJum StefanJum left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I linked gofumpt, their readme provides a bunch of examples about the rules, please check if you think that's enough.

It's perfect.

All good now, thanks.

Reviewed-by: Stefan Jumarea stefanjumarea02@gmail.com

Copy link
Contributor

@razvand razvand left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @LucaSeri

Approved-by: Razvan Deaconescu razvand@unikraft.io

@razvand razvand merged commit fac0db3 into unikraft:main Mar 2, 2024
2 checks passed
@LucaSeri LucaSeri deleted the kraft-contributing branch March 2, 2024 14:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

404 Error When Accessing Krafkit's Contributing Guidelines
3 participants