docs: Improve README.md and CONTRIBUTING.md#429
docs: Improve README.md and CONTRIBUTING.md#429vj7-byte wants to merge 1 commit intofacebook:mainfrom
Conversation
- Add Quick Start section with minimal code example to README - Add Key Features section highlighting CacheLib capabilities - Add Why Use CacheLib section explaining use cases - Add Architecture Overview section for better understanding - Improve Getting Started section with clearer build instructions - Add Community section with links to resources - Enhance CONTRIBUTING.md with documentation contribution guidelines - Add code style guidelines and PR template description - Improve overall clarity and organization of both documents
|
Hi @vj7-byte! Thank you for your pull request and welcome to our community. Action RequiredIn order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you. ProcessIn order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA. Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks! |
|
Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks! |
Summary
This pull request significantly enhances the README.md and CONTRIBUTING.md files to improve the developer experience for new users and contributors.
Key Improvements to README.md
Key Improvements to CONTRIBUTING.md
These changes aim to make CacheLib more accessible and welcoming to both new users and potential contributors.
Test Plan
This is a documentation-only change. All code examples have been reviewed for correctness.