From 034c02d9239760ff02a963c8303f882dcb75ca30 Mon Sep 17 00:00:00 2001 From: Vishal Raj Date: Sun, 20 Aug 2023 15:54:19 +0000 Subject: [PATCH 1/2] feat(docs) : Contributing.md file to increse clo-monitor Score Signed-off-by: Vishal Raj --- CONTRIBUTING.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b3cb93d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,49 @@ +# 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. + +## Getting Started + +For detailed instructions on how to set up the development environment, build, and test kvmservice, refer to our [Contribution Guide](./CONTRIBUTING.md). + +## 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). From e9c5d1b938cff438bce9fda938680b2d1b0aa34a Mon Sep 17 00:00:00 2001 From: Vishal Raj Date: Sun, 20 Aug 2023 15:58:40 +0000 Subject: [PATCH 2/2] feat(docs) : Contributing.md file to increse clo-monitor Score Signed-off-by: Vishal Raj --- CONTRIBUTING.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b3cb93d..e6205de 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -34,10 +34,6 @@ Contributions to kvmservice go beyond code. You can also contribute in the follo 4. **Community Engagement**: Participate in discussions, provide feedback, and assist other contributors on the [KubeArmor Slack](https://kubearmor.slack.com/) and other community channels. -## Getting Started - -For detailed instructions on how to set up the development environment, build, and test kvmservice, refer to our [Contribution Guide](./CONTRIBUTING.md). - ## 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.