Add documentation section to README#368
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## unstable #368 +/- ##
============================================
+ Coverage 43.38% 49.06% +5.67%
============================================
Files 37 45 +8
Lines 2971 3783 +812
============================================
+ Hits 1289 1856 +567
- Misses 1544 1719 +175
- Partials 138 208 +70
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
Thank you for reviewing and merging my PR! I would like to continue contributing to Kvrocks Controller. |
|
@alok-kumar0421 Thanks for your interest. You could have a look at the issues list: https://github.com/apache/kvrocks-controller/issues. |
|
Thanks for the guidance! I’ll go through the issues list and pick one to start working on. |
This PR adds a simple Documentation section to the README.
The repository did not have a dedicated place that pointed new users or contributors to the
right resources, so I added a short section with links and basic guidance.
The intention is to make the README a little more helpful for anyone trying to understand
where to find important information related to Kvrocks.
If anything needs to be improved or adjusted, I can update it.