From d6865bd871a1ff9491264e47301b6c7ffafc39be Mon Sep 17 00:00:00 2001 From: Avinash Sajjanshetty Date: Sat, 28 Oct 2023 13:12:11 +0530 Subject: [PATCH] Add contribution guidelines --- CONTRIBUTING.md | 17 +++++++++++++++++ README.md | 3 +++ 2 files changed, 20 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..4d0b1bb --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,17 @@ +# Contribution Guidelines + +I am happy to accept PRs on CaskDB. For short bug/typo fixes, feel free to open a PR directly. + +I accept PRs related to the challenges mentioned in the different levels. Please open a separate PR for each challenge. The shorter PR is better. It is easier to review and catch bugs. + +For any new feature (or the level challenges) in the db, please open a GitHub issue and discuss your design/changes first. + +Do *NOT* club multiple things into a single PR. This adds unnecessary work for me, and it will take way longer for me to review. +- CaskDB is an educational project. PRs become a great learning point for someone new to navigate the codebase and add a new feature. +- Your PRs will be a great stepping stone for someone else who is new. + +Thank you! + +## "I am new; how do I get started?" + +Pick any challenge from any level and open a GitHub issue to discuss. I am happy to provide more resources/research papers to understand a particular concept. diff --git a/README.md b/README.md index 47f2bf6..d18ec93 100644 --- a/README.md +++ b/README.md @@ -123,5 +123,8 @@ $ tokei -f format.py disk_store.py =============================================================================== ``` +## Contributing +All contributions are welcome. Please check [CONTRIBUTING.md](CONTRIBUTING.md) for more details. + ## License The MIT license. Please check `LICENSE` for more details.