Introduction

Hey Contributors 🚀! Thank you for choosing to contribute to KEcoLab. Your contributions are highly valued and help us build a better tool for everyone. These guidelines are designed to make the contribution process as smooth and efficient as possible.

Code of Conduct

We are committed to fostering an open and welcoming environment. Please review and adhere to our Code of Conduct. By participating, you are expected to uphold these principles and contribute positively to our community.

Be Respectful: Treat all contributors and users with respect and kindness. Avoid personal attacks, derogatory language, or discriminatory behavior.
Be Inclusive: Welcome diverse perspectives and experiences. Create an inclusive environment where everyone feels comfortable contributing.
Be Collaborative: Work together to achieve common goals. Be open to feedback and willing to compromise.
Be Responsible: Take responsibility for your actions and their impact on the community.
Follow Guidelines: Make sure to follow certain process(creating issues, new branch, create MR)

Ways to Contribute

There are many ways you can contribute to KEcoLab, including:

Reporting Bugs: If you encounter a bug, please report it by creating a new issue(If possible provide a possible solution in the issue).
Suggesting Enhancements: Have an idea for a new feature or improvement of existing pipeline? Open an issue to discuss it.
Submitting Code: You can contribute by fixing bugs, adding new features, or improving existing code.
Improving Documentation: Help us improve our documentation by fixing typos, adding examples, or clarifying explanations. The documents are hosted in KDE Community Wiki. You can checkout here: KEcoLab.

Find an issue

Navigate to issues section of the KEcoLab project repository. Find the suitable issue that works for you or create a new issue by clicking create new issue.

When creating a new issue, make sure to provide a detailed explanation(i.e., steps to reproduce) with screenshorts for our understanding. It will be great to know your view of the solution to the issue you are facing or the new feature or enhancement you are proposing.

You can also find the existing issue by their difficulty levels. Low stands for beginner level issues, med stands for intermediator level issues, and high stands for advanced level issues that require subject matter concepts.

Create a MR

Once you find the issue you want to work on, just comment in the issue saying that you are working on. In this way, the issue will be assigned to you and you can start working on the issue.

You can checkout our user guide for how to start with our KEcoLab Project and CI/CD pipeline documentation to know more about how the pipeline automates the energy measurement process.

Before starting the issue, you have to fork the repository and create a new branch for you to make changes in the code. Once the changes has been done, you can create a merge request from your forked repository to the main repository. It is advisory to create your own branch and do not to make changes in the main branch.

Ask for Help

If you need any help regarding the project or execution, you can always reach out to us through our matrix channel: https://go.kde.org/matrix/#/#kde-eco-dev:kde.org .

Happy Contributing 🎊 !