Contributing to ElectricSQL

September 30, 2022 ยท View on GitHub

Welcome to the ElectricSQL developer community. Thanks for taking the time to contribute!

This guide covers two main topics:

  1. the legal terms under which you contribute to the project
  2. the guidelines for how to contribute to the project

ElectricSQL operates under the default GitHub terms, where your contributions are licensed under the terms of our contributor license agreement. The ElectricSQL Contributor License Agreement ("CLA") is a legal agreement that essentially assigns the IP in your contributions to the ElectricSQL project.

How do I accept the CLA?

The ElectricSQL repositories are defined as any repository hosted on the GitHub platform within the electric-sql organisation. By contributing code to any of the ElectricSQL repositories, for example by pushing commits to GitHub and / or by raising a Pull Request, you indicate your acceptance of the CLA.

:warning: Do not contributing code to any of the ElectricSQL repositories unless you accept the ElectricSQL Contributor License Agreement. Contributing code to the ElectricSQL repositories indicates your acceptance of the terms.

Contributor Guidelines

Please read the guideance below about what to do if you:

Did you find a bug?

  • ensure that the bug was not already reported by searching on GitHub under the relevant issue tracker
  • if you're unable to find an open issue addressing the problem, open a new one

Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Did you write a patch that fixes a bug?

  • open a new GitHub pull request with the patch
  • ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable

Do you intend to add a new feature or change an existing one?

  • say hello and suggest your change on the discussion channels for the ElectricSQL community
  • assuming you get positive feedback, raise a Pull Request against your fork/branch to track the development of the feature and discuss the implementation

Then write some code ;) We welcome contributions and encourage you to pitch in :)