DBeaver Documentation


Contribute your code

Create pull requests

Before creating a pull request, you should create a ticket on our issue tracker. You can leave a comment saying that you are going to implement this feature (or fix a bug) by yourself. After the DBeaver dev/qa team replies to your comment, you can then start working on it.

You can use the standard GitHub instruction. Generally, you need to create a fork of the dbeaver/dbeaver repository, create a new branch, commit your changes, and then create a pull request in the upstream repository.

Important: When you commit changes in your branch, add the ticket number in the commit comment.
Like this: dbeaver/dbeaver#issue-number Initial commit for my super-duper feature.
You can make any number of commits. We usually perform squash before merging changes in the main repository.

Pull request guidelines

  • Please avoid creating multiple pull requests for one issue.
  • Please provide a detailed description of the affected functionality.
  • Avoid force-pushing the commits in the PR branch, this makes reading commit history more difficult.
  • If UI is affected, it is recommended to provide screenshots or video with a demonstration of the made changes

Can I fix a bug by myself

If you think that a bug on our board has to be fixed and, for some reason, it is not in the nearest milestone, then you could try fixing it by yourself. It makes sense to ask about it in the ticket because we sometimes do not resolve tickets for a reason.

If you decide that you want to fix the bug and make a pull request (see above), the team will review it and write a PR review if necessary. If the PR is merged, then the fix will appear in the next version of the DBeaver community (which is released every two weeks).

What types of new features are acceptable

Generally, you could suggest anything you think is useful in the database management tool. However, we usually do not implement features too specific for your development process or specific to your internal company processes.

Good options:

  • Add new database or driver support
  • Extend database metadata read/modify (e.g., add triggers read it a specific database)
  • Add a new SQL generator
  • Add new data export format
  • Localize DBeaver interface (extend existing localization or add a new language. Instruction)
  • Add a new database-specific tool (e.g., table analyze for a specific database)

There are samples of all these features in our codebase.


Code guidelines

The main rule: use the same codestyle, which is already used in a particular source file.

  • Historically there are several slightly different code styles in our codebase. However if you modify an old file, it is better to use the same codestyle, which is used in this file.
  • Do not reformat code or optimize all imports in a file you are changing, otherwise it is very hard to review your commits otherwise (due to a lot of changes)
  • Use our automatic codestyle checks in PRs (every PR you make in the dbeaver/dbeaver repository will be checked, and you can see the report of the check list)

IntelliJ IDEA code style can be found at: https://github.com/dbeaver/dbeaver-idea-project

Code style