Feathr Pull Request(PR) Guideline

Creating Github issue

Every PR should be proceeded by a Github issue to explain the problem statement unless it’s trivial bug fixes or documentation change. If your change is significant, please make sure your PR reviewers can align on the problem statement via Github issue first.

The Github issue should contain the detailed problem statement.

PR Description


  • What changes to make and why you are making these changes.
  • How are you going to achieve your goal Describe what testings you have done, for example, performance testing etc.

Checklist that might be helpful to facilitate the review:

  • Design one-pager, design doc, or RFC
  • Github Issue

Add new dependencies

Please list the new dependencies in the PR description with

  • What’s their license
  • Are they compatible with our license