Skip to content

Latest commit

 

History

History
94 lines (63 loc) · 3.48 KB

CONTRIBUTING.md

File metadata and controls

94 lines (63 loc) · 3.48 KB
Raw

How to contribute

This document outlines some of the conventions on development workflow, commit message formatting, contact points and other resources to make it easier to get your contribution accepted.

Get started

  • Fork the repository on GitHub.
  • Read the README.md for build instructions.
  • Play with the project, submit bugs, submit patches!

Build TiDB-CDC

Developing TiDB-CDC requires:

  • Go 1.21+
  • An internet connection to download the dependencies

Simply run make to build the program.

make

Run tests

This project contains unit tests and integration tests with coverage collection. See tests/integration_tests/README.md for how to execute and add tests.

For more information on how to trigger these tests, please see the command help.

Debug with Delve

dlv debug --build-flags="-ldflags='-X github.com/pingcap/tiflow/pkg/version.ReleaseVersion=$(git describe --tags)'" ./cmd/cdc -- server

Update dependencies

TiDB-CDC uses Go Modules to manage dependencies. To add or update a dependency: use the go mod edit command to change the dependency.

Contribution flow

This is a rough outline of what a contributor's workflow looks like:

  • Create a topic branch from where you want to base your work. This is usually master.
  • Make commits of logical units and add test case if the change fixes a bug or adds new functionality.
  • Run tests and make sure all the tests are passed.
  • Make sure your commit messages are in the proper format (see below).
  • Push your changes to a topic branch in your fork of the repository.
  • Submit a pull request.
  • Your PR must receive LGTMs from two maintainers.

Thanks for your contributions!

Code style

The coding style suggested by the Golang community is used in TiDB-CDC. See the style doc for details.

Please follow this style to make TiDB-CDC easy to review, maintain and develop.

Commit message format

We follow a rough convention for commit messages that is designed to answer two questions: what changed and why. The subject line should feature the what and the body of the commit should describe the why.

capture(ticdc): add comment for variable declaration

Improve documentation.

The format can be described more formally as follows:

<subsystem>(ticdc|dm|engine|all): <what changed>
<BLANK LINE>
<why this change was made>
<BLANK LINE>
<footer>(optional)

The first line is the subject and should be no longer than 70 characters, the second line is always blank, and other lines should be wrapped at 80 characters. This allows the message to be easier to read on GitHub as well as in various git tools.

  • If the change affects more than one subsystem, use a comma to separate them like capture,puller:.
  • If the change affects many subsystems, use * instead, like *:.
  • If the change affects only TiCDC, use <subsystem>(ticdc):.
  • If the change affects only DM, use <subsystem>(dm):.
  • If the change affects only the dataflow engine, use <subsystem>(engine):.
  • If the change involves code that is used by all products, use <subsystem>(all):.

For the why part, if no specific reason for the change, you can use one of some generic reasons like "Improve documentation.", "Improve performance.", "Improve robustness.", "Improve test coverage."