Thank you so much for contributing to devourKV. We appreciate your time and help. Here are some guidelines to help you get started.
- Before filing an issue, please check the existing issues to see if a similar one was already opened. If there is one already opened, feel free to comment on it.
- If you believe you've found a bug, please provide detailed steps of reproduction, the version of devourKV and anything else you believe will be useful to help troubleshoot it (e.g. OS environment, environment variables, etc...). Also state the current behavior vs. the expected behavior.
- If you'd like to see a feature or an enhancement please open an issue with a clear title and description of what the feature is and why it would be beneficial to the project and its users.
As much as possible, try to follow the existing format of markdown and code.
- Don't forget to run
make testandmake fmtbefore submitting pull requests. - Make sure that 100% of your code is covered by tests.
-
Mention your issue number linked to the pull request while creating one :
closes <Issue_No.> -
While creating a new branch, follow the naming conventions below :
a. Adding a new feature :
feature/kv- <Issue_No.>b. Fixing a bug :
bugfix/kv- <Issue_No.> -
While committing the changes, follow the commit message convention as below :
#<Issue_No.> UPD : <commit message>
- Fork the project.
- Download your fork to your PC (
git clone https://github.com/your_username/devourKV && cd devourKV) - Create your feature branch (
git checkout -b <branch name>) - Make changes and run tests (
make test) - Format the code (
make fmt) - Add them to staging (
git add .) - Commit your changes (
git commit -m '#<Issue_No> UPD : <Commit Message>') - Push to the branch
- Create new pull request