Welcome! We're excited that you're interested in contributing to ParadeDB and want to make the process as smooth as possible.
Before submitting a pull request, please review this document, which outlines what conventions to follow when submitting changes. If you have any questions not covered in this document, please reach out to us in the ParadeDB Community Slack or via email.
This repository has a workflow to automatically assign issues to new contributors. This ensures that you don't need approval from a maintainer to pick an issue.
- Before claiming an issue, ensure that:
- It's not already assigned to someone else
- There are no comments indicating ongoing work
- To claim an unassigned issue, simply comment
/takeon the issue. This will automatically assign the issue to you.
If you find yourself unable to make progress, don't hesitate to seek help in the issue comments or in the ParadeDB Community Slack. If you no longer wish to
work on the issue(s) you self-assigned, please use the unassign me link at the top of the issue(s) page to release it.
ParadeDB is structured as a monorepo containing our Postgres extensions, our Docker setup, and our development tools for benchmarking and testing.
The development of our Postgres extensions is done via pgrx. For development instructions regarding a specific Postgres extension, please refer to the Development section of the README in the extension's subfolder.
The development of ParadeDB, which is the combination of our Postgres extensions and of community Postgres extensions packaged together, is done via Docker. If you are contributing to our Docker setup, we encourage you to use Docker Compose to build and test with the development file via docker compose -f docker-compose.dev.yml up.
All changes to ParadeDB happen through GitHub Pull Requests. Here is the recommended flow for making a change:
- Before working on a change, please check to see if there is already a GitHub issue open for that change.
- If there is not, please open an issue first. This gives the community visibility into what you're working on and allows others to make suggestions and leave comments.
- Fork the ParadeDB repo and branch out from the
devbranch. - Install pre-commit hooks within your fork with
pre-commit installto ensure code quality and consistency with upstream. - Make your changes. If you've added new functionality, please add tests. We will not merge a feature without appropriate tests.
- Open a pull request towards the
devbranch. Ensure that all tests and checks pass. Note that the ParadeDB repository has pull request title linting in place and follows the Conventional Commits spec. - Congratulations! Our team will review your pull request.
ParadeDB's public-facing documentation is stored in the docs folder. If you are adding a new feature that requires new documentation, please add the documentation as part of your pull request. We will not merge a feature without appropriate documentation.
In order for us, Retake, Inc. (dba ParadeDB) to accept patches and other contributions from you, you need to adopt our ParadeDB Contributor License Agreement (the "CLA"). The current version of the CLA can be found here.
ParadeDB uses a tool called CLA Assistant to help us keep track of the CLA status of contributors. CLA Assistant will post a comment to your pull request indicating whether you have signed the CLA or not. If you have not signed the CLA, you will need to do so before we can accept your contribution. Signing the CLA is a one-time process, is valid for all future contributions to ParadeDB, and can be done in under a minute by signing in with your GitHub account.
If you have any questions about the CLA, please reach out to us in the ParadeDB Community Slack or via email at [email protected].
By contributing to ParadeDB, you agree that your contributions will be licensed under the GNU Affero General Public License v3.0 and as commercial software.