Contributing to Apache Cloudberry PXF

Apache Cloudberry community welcomes contributions from anyone, new and experienced!

Code of Conduct

All participants are expected to follow the Code of Conduct. Use welcoming and inclusive language, respect differing viewpoints, and foster what's best for the community.

GitHub Contribution Workflow

1. Fork the cloudberry-pxf repository to your GitHub account

2. Clone your fork:

   git clone https://github.com/your-user-name/cloudberry-pxf.git

3. Add upstream (one-time setup):

   git remote add upstream https://github.com/apache/cloudberry-pxf.git

4. Create a branch for your work:

   git checkout -b my-feature-branch

5. Make changes, commit, and push:

   git add <changed files>
   git commit -m "descriptive commit message"
   git push origin my-feature-branch

6. Open a Pull Request on GitHub

7. Get reviewed — address feedback, iterate

8. Once approved and CI passes, your code will be merged

Keeping Your Fork in Sync

git checkout main
git fetch upstream
git rebase upstream/main

What to Contribute

• Bug fixes — check GitHub Issues
• New connectors — see Writing Connectors
• Documentation — improvements to this doc site
• Tests — additional test coverage
• Performance — optimizations and benchmarks