docs: add CONTRIBUTING.md

CONTRIBUTING.md

@@ -0,0 +1,28 @@
+# Contributing
+
+When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
+
+Please note we have a [Code of Conduct](CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
+
+# Pull Request Process
+
+You can contribute changes to this repo by opening a pull request:
+
+1. After forking this repository to your Git account, make the proposed changes on your forked branch.
+2. Run tests and linting locally.
+   - Run `pnpm test:services:start`, allow for the services to come up.
+   - Run `pnpm test`.
+   - You can now run `pnpm test:services:stop` to stop the services.
+3. Commit your changes and push them to your forked repository.
+4. Navigate to the main `upstash-keyv` repository and select the _Pull Requests_ tab.
+5. Click the _New pull request_ button, then select the option "Compare across forks"
+6. Leave the base branch set to main. Set the compare branch to your forked branch, and open the pull request.
+7. Once your pull request is created, ensure that all checks have passed and that your branch has no conflicts with the base branch. If there are any issues, resolve these changes in your local repository, and then commit and push them to git.
+8. Similarly, respond to any reviewer comments or requests for changes by making edits to your local repository and pushing them to Git.
+9. Once the pull request has been reviewed, those with write access to the branch will be able to merge your changes into the `keyv` repository.
+
+If you need more information on the steps to create a pull request, you can find a detailed walkthrough in the [Github documentation](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)
+
+# Code of Conduct
+
+Please refer to this [Code of Conduct](https://github.com/jaredwray/keyv/blob/main/CODE_OF_CONDUCT.md) readme for how to contribute to this open source project.

README.md

@@ -34,6 +34,7 @@ In case you are passing a custom Upstash client instance, make sure to pass an i
 - [Using Cacheable with Upstash Redis](#using-cacheable-with-upstash-redis)
 - [API](#api)
 - [Differences from @keyv/redis](#differences-from-keyvredis)
+- [Contributing](CONTRIBUTING.md)
 - [License](#license)
 
 ## Usage