Contributing

Everyone who participates in Cloudberry, either as a user or a contributor, is obliged to follow the Code of Conduct.

Getting Started

To get started, follow these steps:

• Fork the cloudberry-backup repository on GitHub
• Run go get github.com/apache/cloudberry-backup/... and add your fork as a remote
• Run make depend to install required dependencies
• Follow the README to set up your environment and run the tests

Creating a change

• Create your own feature branch (e.g. git checkout -b new_branch) and make changes on this branch.
• Try and follow similar coding styles as found throughout the codebase.
• Make commits as logical units for ease of reviewing.
• Rebase with main often to stay in sync with upstream.
• Add new tests to cover your code. We use Ginkgo and Gomega for testing.
• Ensure a well written commit message as explained here.
• Run make format, make test, and make end_to_end in your feature branch and ensure they are successful.
• Push your local branch to the fork (e.g. git push <your_fork> backup_branch)
• Create a Pull Request from your fork