How to Contribute Code to Liquibase Core


Need Help?

Overview

  1. Browse to the Liquibase Core project in GitHub: https://github.com/liquibase/liquibase

  2. Make sure the default branch is master

  3. Fork it

  4. Clone it to your local system

  5. Make a new branch

  6. Make your changes

  7. Push your changes back into your repo

  8. Click the Compare & pull request button

  9. Click Create pull request to open a new pull request at liquibase/liquibase

Step-by-Step Instructions

1. Browse to the Liquibase Core project in GitHub

Open a browser and navigate to the Liquibase project in GitHub: https://github.com/liquibase/liquibase

2. Select master as the default branch

3. Fork the Liquibase Core Project

Click on the Fork button in the top-right corner.

This creates a new copy of Liquibase under your GitHub user account with a URL like:

1 https://github.com/<YourUserName>/liquibase

and includes all the code, branches, and commits from the original repo.

4. Clone the repository

Clone the source code repo

Clone the source repo by opening the terminal on your computer and running the command:

1 git clone https://github.com/<YourUserName>/liquibase

This repo also includes the unit tests for Liquibase Core. See this page for more information on writing or enhancing Liquibase Core unit tests.

5. Create a branch and set the upstream repository

Once the repo is cloned, you need to do two things:

  1. Create a new branch by issuing the command:

    1 git checkout -b new_branch
  2. Create a new remote for the upstream repo with the command:

    1 git remote add upstream https://github.com/liquibase/liquibase

In this case, "upstream repo" refers to the original repo you created your fork from.

6. Make your changes

Now you can make your changes and additions to Liquibase Core.

  1. Make Code Changes

  2. Add Unit and Integration Tests

  3. Provide Feedback for Liquibase Documentation

7. Push the changes back to your repo

Push your changes back to your repo in GitHub.

1 git push -u origin <newBranchName>

When you do, the Compare & pull request button will appear in GitHub.

8. Create a new pull request at liquibase/liquibase

Open a pull request by clicking the Compare & pull request button. This allows the Liquibase maintainers to review your contribution. Click it and you'll be taken to this screen:

9. Fill out the pull request template, and click the Create pull request button

This will submit your pull request for our team to review.

10. Receive updates on your pull request

Thank you for submitting your pull request!

  1. Now that your pull request has been submitted, the automated build will be triggered. It usually takes less than 10 minutes to complete. The results will be available in the comments of your PR. Please review the results. If the build or any of the tests fail, please make any necessary changes and resubmit your PR.

  2. Once the tests have all passed, we will review it for completeness, prioritize it, and schedule it to be integrated into Liquibase Core. You will receive updates on the progress of your PR in the comment section of your PR’s GitHub page.