Skip to content

Latest commit

 

History

History
30 lines (26 loc) · 1.5 KB

CONTRIBUTING.md

File metadata and controls

30 lines (26 loc) · 1.5 KB

Contributing to DMDS

You can report a bug, submit a new feature enhancement recommendation, or commit codes by a pull request.

Reporting bugs

  • Before report a bug, please search from google to confirm you cannot find any hint on it.
  • Look issues List to confirm this issue is not a duplicated one.
  • Create a new issue.
  • Define a clear and descriptive title for the issue.
  • If bug reported, please provide information below:
    • Details for reproduce bug step by step. Include SQL, configuration, expected results, actual results and tracing log.
    • DMDS and JDK version.
    • Source code to reproduce bug on github and copy the link here.
    • Screenshot for CPU, Memory, Network and IO stat if performance issue.
  • If enhancement recommendation reported, please provide information below:
    • Details for enhancement behaviour.
    • Explain why this enhancement is general feature for most developers.

Commit pull request

  • Fork from DMDS
  • Clone fork to your own machine
  • Create new branch with your issue
  • Develop and test. You can see Develop Note for more details.
  • Commit changes to your own branch
  • Push your work back up to your fork
  • Submit a Pull request so that we can review your changes
  • Code will be merged after accepted. Before accepted We will do code review and discuss some details, include design, implement, performance and code style.

Note

Be sure to merge the latest from "upstream" before making a pull request!