Skip to content

Latest commit

 

History

History
24 lines (15 loc) · 1.16 KB

How-to-propose-a-PR.md

File metadata and controls

24 lines (15 loc) · 1.16 KB

A good pull-request should contain

Change list

There should be provided briefly described change list which are you going to propose.

Types of changes

What types of changes are proposed/introduced to Java client? Put an x in the boxes that apply

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Details

There should be provided more details about changes if it is necessary. If there are new features you can provide code samples which show the way they work and possible use cases. Also you can create gists with pasted java code samples or put them at a PR description using markdown. About markdown please read Mastering markdown and Writing on GitHub

Pull-request template

There is PULL_REQUEST_TEMPLATE.md which should help you to make a good pull request.