Contributing to Drift KV

Thank you for your interest in contributing to Drift KV! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Here are some guidelines to help you contribute effectively.

How to Contribute

Code of Conduct

By participating in this project, you agree to abide by the Code of Conduct. Please read it to understand our expectations.

Bug Reports

If you find a bug in Drift KV, please open an issue with as much detail as possible.

• Title

  Provide a clear and descriptive title for the issue.
• Description

  Describe the issue you are experiencing.
• Steps to Reproduce

  Provide step-by-step instructions for reproducing the issue.
• Expected Result

  What did you expect to happen?
• Actual Result

  What actually happened?

Feature Requests

Have a great idea for a feature that you would like to see in Drift KV? Feel free to open a feature request.

• Explain the feature you'd like to see and why it would be useful.
• Provide any additional context that could help in implementing the feature.

Code Contributions

We love code contributions! To help keep everything organized and to ensure we can effectively review and merge contributions, please follow these steps.

Development Setup

To get started with contributing, set up the project locally:

1. Fork the repository.
2. Clone the forked repository:
   git clone https://github.com/felipebarcelospro/drift-kv.git
   cd drift-kv
   

3. Install the dependencies:
   npm install
   

Pull Request Process

1. Create a branch from main for your changes:

   git checkout -b feature/my-awesome-feature
   

2. Make your changes.

3. Commit your changes and push to your fork:

   git add .
   git commit -m "Add awesome new feature"
   git push origin feature/my-awesome-feature
   

4. Open a pull request to the main repository, including a detailed description of your changes.

5. Wait for a maintainer to review and provide feedback. Make any necessary updates based on feedback.

Community

• Follow me on X: @feldbarcelospro
• Join us on GitHub Discussions: Drift Community
• Project Link: https://github.com/felipebarcelospro/drift-kv

Thank you for contributing to Drift KV!