Skip to content

Latest commit

 

History

History
43 lines (26 loc) · 1.97 KB

CONTRIBUTING.md

File metadata and controls

43 lines (26 loc) · 1.97 KB
Raw

Contributing

Welcome! We're thrilled that you're interested in contributing to cachified-adapter-cloudflare-kv. Your contributions will help improve the project and benefit the community.

Here are some guidelines to help you get started:

Setting Up the Repository

To set up the repository on your local machine, follow these steps:

  1. Clone the repository using git clone https://github.com/AdiRishi/cachified-adapter-cloudflare-kv.
  2. Move into the project directory with cd cachified-adapter-cloudflare-kv.
  3. Install the project dependencies by running pnpm install.

Making a Pull Request

Before submitting a pull request, ensure you adhere to the following:

  1. Run lint and test commands to check for any errors. You can do this by running pnpm lint and pnpm test.
  2. Write unit tests for any changes you make. This helps maintain the quality of the code and ensures that your changes don't accidentally break anything.
  3. Always sign your commits. This confirms that the changes come from a trusted source. Read this documentation to learn how to sign commits.

To create a pull request:

  1. Push your changes to your fork of the repository.
  2. Go to the cachified-adapter-cloudflare-kv page in your GitHub account.
  3. Click the New pull request button.

In the New pull request page:

  1. Choose the original repository as base repository and your fork as the head repository.
  2. Confirm your changes and submit your pull request.

Depending on the scope of your changes, you may need to create a changeset for your pull request. Read this documentation on how to create a changeset.

By contributing to this project, you agree to abide by our Code of Conduct.

We appreciate your interest in contributing and look forward to your pull requests!