[D] Making a README in Kvrocks purely for developers [kvrocks]

["jonathanc-n (via GitHub)" <gi...@apache.org>]

GitHub user jonathanc-n created a discussion: Making a README in Kvrocks purely for developers

To make it easier for new developers to get started on Kvrocks, I'm proposing to add a README in the repository (for a developer's convenience):
- Explain the certain folders that hold certain functionality (ex. search folder -> KQIR)
- Describe certain functionality (ex. MakeCmdAttr, metadata handling, etc.)
- Committing guidelines, such as splitting larger PRs into smaller commits making it easier for reviewers. (referenced from Meta's Velox)

These were just a few ideas that I came up with off the top of my head. If you can think of more, please feel free to add!

GitHub link: https://github.com/apache/kvrocks/discussions/2551

----
This is an automatically sent email for issues@kvrocks.apache.org.
To unsubscribe, please send an email to: issues-unsubscribe@kvrocks.apache.org

Re: [D] Making a README in Kvrocks purely for developers [kvrocks]

["tisonkun (via GitHub)" <gi...@apache.org>]

GitHub user tisonkun added a comment to the discussion: Making a README in Kvrocks purely for developers

This is typically called "CONTRIBUTING.md" :D

GitHub link: https://github.com/apache/kvrocks/discussions/2551#discussioncomment-10715809

----
This is an automatically sent email for issues@kvrocks.apache.org.
To unsubscribe, please send an email to: issues-unsubscribe@kvrocks.apache.org

Re: [D] Making a README in Kvrocks purely for developers [kvrocks]

["jonathanc-n (via GitHub)" <gi...@apache.org>]

GitHub user jonathanc-n added a comment to the discussion: Making a README in Kvrocks purely for developers

Oh yeah lmfao, I forgot

GitHub link: https://github.com/apache/kvrocks/discussions/2551#discussioncomment-10715847

----
This is an automatically sent email for issues@kvrocks.apache.org.
To unsubscribe, please send an email to: issues-unsubscribe@kvrocks.apache.org