Skip to content

Latest commit

 

History

History
51 lines (37 loc) · 1.99 KB

CONTRIBUTING.md

File metadata and controls

51 lines (37 loc) · 1.99 KB
Raw

🌟 Contributing to Kermoo 🚀

Hello, dear developer! 🙌 First off, a massive thank you for considering contributing to Kermoo. Whether you're here to fix a bug, add a feature, or even improve our documentation, you're making Kermoo even better, and for that, we're grateful. 🎉

🛠️ Setting Up Kermoo for Local Development

Before diving into the code, it's essential to get Kermoo up and running on your machine. Here's a step-by-step guide to setting things up:

  1. Fork and Clone this repository.
  2. Navigate into your local Kermoo directory.
  3. Download Dependencies: 
    make mod-download-local
  4. Run Tests with Coverage: 
    make test-with-coverage
  5. Execute End-to-End Tests: 
    make test-e2e
  6. Build for Local: 
    make build-local

With these steps, Kermoo should be primed and ready on your local environment! 🚀

📝 How to Contribute?

  • Branch out: Create a new branch for every feature or fix you're working on.
  • Write: Dive in and make your changes.
  • Test: Make sure to run our test suite to maintain code quality.
  • Commit: Commit your changes with a meaningful message.
  • Push: Push your branch to your fork.
  • Pull Request: Open a PR from your fork to Kermoo's main branch.

📚 Code of Conduct

It's crucial for everyone to feel welcomed and valued. Therefore, we ask that you read and follow our Code of Conduct to ensure a harmonious environment.

❓ Need Assistance?

If you're unsure or have questions, we encourage you to open a new discussion. We're here to guide and assist! 🤝

🎉 In Conclusion...

Each contribution, no matter how small (even a simple typo correction), shapes Kermoo into a better version of itself. So, from all of us here, THANK YOU! Your efforts make a significant impact. ❤️

Keep the code flowing! 🎉🚀🌟