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.

Sign up for GitHub

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

Jump to bottom

Added instructions to setup kubescape locally #1239

Merged
merged 3 commits into from May 18, 2023
Merged

Added instructions to setup kubescape locally #1239

merged 3 commits into from May 18, 2023

Conversation

yrs147
Copy link
Contributor

@yrs147 yrs147 commented May 18, 2023

Overview

The CONTRIBUTING.md file was lacking information on how to set up kubescape locally. To assist new contributors, I have added instructions for this purpose.

Screenshots

image

image

@yrs147
Added instructions to setup kubescape locally
231d9c2 
Signed-off-by: Yash Raj <yashraj14700728@gmail.com>
@HollowMan6
Copy link
Contributor

I think we shall put a link to https://github.com/kubescape/kubescape/wiki/Building instead of duplicating the information there.

@matthyx
Copy link
Contributor

matthyx commented May 18, 2023

There is also something wrong here, I thought we only needed libgit when building with the flag gitenabled but the documentation doesn't reflect that.
There should also be somewhere a mention that for performance reasons it's better to build with this dependency when scanning git repos.
For reference it was introduced with #969

@HollowMan6
Copy link
Contributor

@matthyx Okay, I didn't aware that this was outdated when I moved the building instructions there through this PR: #1196 I will try to update the instructions accordingly then.

HollowMan6
HollowMan6 suggested changes May 18, 2023
View reviewed changes
CONTRIBUTING.md Outdated Show resolved Hide resolved
HollowMan6
HollowMan6 suggested changes May 18, 2023
View reviewed changes
CONTRIBUTING.md Outdated Show resolved Hide resolved
HollowMan6
HollowMan6 approved these changes May 18, 2023
View reviewed changes
Copy link
Contributor

@HollowMan6 HollowMan6 left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@HollowMan6 HollowMan6 force-pushed the master branch 2 times, most recently from fa092f4 to 5bf7d6a Compare May 18, 2023 10:37
yrs147 and others added 2 commits May 18, 2023 13:38
@yrs147 @HollowMan6
Removed instructions and added the wiki link
efd48ea 
Co-authored-by: Hollow Man <hollowman@opensuse.org>

Signed-off-by: Yash Raj Singh <98258627+yrs147@users.noreply.github.com>
@HollowMan6
Add back new line at the end of the file
3357713 
Signed-off-by: Hollow Man <hollowman@opensuse.org>
@HollowMan6
Copy link
Contributor

cc: @matthyx @craigbox You may want to merge this.

@HollowMan6
Copy link
Contributor

Updated! https://github.com/kubescape/kubescape/wiki/Building

@matthyx Okay, I didn't aware that this was outdated when I moved the building instructions there through this PR: #1196 I will try to update the instructions accordingly then.

@craigbox craigbox merged commit 7bffed2 into kubescape:master May 18, 2023
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@craigbox craigbox craigbox approved these changes

@HollowMan6 HollowMan6 HollowMan6 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@yrs147 @HollowMan6 @matthyx @craigbox