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

docs: Added Contributing.md file to increase clo-monitor Score #64

Merged
merged 2 commits into from
Sep 9, 2023
Merged

docs: Added Contributing.md file to increase clo-monitor Score #64

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
034c02d
feat(docs) : Contributing.md file to increse clo-monitor Score
vishalrajofficial Aug 20, 2023
e9c5d1b
feat(docs) : Contributing.md file to increse clo-monitor Score
vishalrajofficial Aug 20, 2023
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
45 changes: 45 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# How to Contribute to KubeArmor VM Service (kvmservice)?

Thank you for your interest in contributing to KubeArmor VM Service (kvmservice)! Your contributions can help enhance this project and benefit the wider community. Here's how you can get involved:

## Finding an Issue to Work On

1. Check out the [issue tracker](https://github.com/kubearmor/kvm-service/issues) to find issues that match your skills and interests.

2. If you're new to the project, consider looking for issues labeled as [good-first-issue](https://github.com/kubearmor/kvm-service/labels/good%20first%20issue) for a beginner-friendly start.

3. Experienced contributors can take on more challenging tasks by selecting issues labeled as [help-wanted](https://github.com/kubearmor/kvm-service/labels/help%20wanted).

## Contributing Code

1. Fork the repository and create a new branch for your contribution.

2. Implement your changes and improvements.

3. Follow the project's coding style and conventions.

4. Ensure your code is well-tested and doesn't introduce any regressions.

5. Submit a pull request to the main repository. Provide a clear description of your changes and why they are valuable.

## Scope of Contribution

Contributions to kvmservice go beyond code. You can also contribute in the following ways:

1. **Documentation**: Improve existing documentation or add new sections to make it easier for users and contributors to understand and use kvmservice.

2. **Testing and Bug Reports**: Help identify and report bugs, as well as test fixes and improvements to ensure a stable and reliable project.

3. **Feature Ideas**: Share your ideas for new features or enhancements that can add value to kvmservice.

4. **Community Engagement**: Participate in discussions, provide feedback, and assist other contributors on the [KubeArmor Slack](https://kubearmor.slack.com/) and other community channels.

## Code of Conduct

When contributing to kvmservice, please adhere to our [Code of Conduct](./CODE_OF_CONDUCT.md). We aim to create a welcoming and inclusive environment for all contributors.

## Get Involved

Your contributions are vital to the success of KubeArmor VM Service (kvmservice). Thank you for being part of our community and helping us make kvmservice even better!

For more information, you can visit our [project's homepage](https://github.com/kubearmor/kvm-service) and [KubeArmor Wiki](https://github.com/kubearmor/KubeArmor/wiki).
Loading