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

new(contributing): Added contributing.md file #354

Merged
merged 2 commits into from
Aug 14, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# How to Contribute to KubeArmor-Client?

1. Pick an [issue](https://github.com/kubearmor/kubearmor-client/issues) to work on. For first-time contributors, the best would be to pick an issue [tagged good-first-issue](https://github.com/kubearmor/kubearmor-client/labels/good%20first%20issue).

2. If you feel adventurous and would like to take a challenging issue, we would love to have you contribute on issues [tagged help-wanted](https://github.com/kubearmor/kubearmor-client/labels/help%20wanted).

3. There is a [Contribution Guide](https://github.com/kubearmor/KubeArmor/blob/main/contribution/contribution_guide.md) that explains how to create a fork and raise PR on GitHub.

4. If the issue involves code changes you need to install development env using this [Development Guide](https://github.com/kubearmor/KubeArmor/blob/main/contribution/development_guide.md).

# Scope of Contribution

Contributions are not necessarily in the form of code changes. KubeArmor community can benefit from contributions such as:

1. [Policy-Templates](https://github.com/kubearmor/policy-templates)

Users are welcome to contribute policy-templates for their workloads. The workloads have to be generic enough such that it benefits the wider community. E.g., if someone brings up a system policy restricting access to nginx process that would be useful in multiple scenarios and for the wider community then come up with a policy-template that is specific to your proprietary application.

2. Blogs

a. Explain The use of KubeArmor-Client's features (KVMService, Event Auditor, Visibility, etc)

b. Describe How to use KubeArmor-Client to protect your workload with specific use-cases you may have. Please do not shy away from getting as technical as you can.

c. Put your topic of interest

3. Feedback to the community

Just helping advance any discussion on KubeArmor Slack, Community meetings, office hours will make a big difference.

4. Talking about KubeArmor-Client in meetups

We would certainly encourage users or devs of KubeArmor to talk about it in open/closed forums. The community can help with logistics such as compiling/feedback on slide-decks, technical diagrams, etc.
Loading