Skip to content

Latest commit

 

History

History
32 lines (23 loc) · 2.08 KB

CONTRIBUTING.md

File metadata and controls

32 lines (23 loc) · 2.08 KB
Raw

How to Contribute

We are excited that you are interested in contributing to Pipcook. Before submitting your contribution, please take a moment to read through a few small guidelines here

Reporting Issues

  • We use Github issues to manage our issues. We use status to mark the progress of our issues.

  • Try to search for your issue, it may have already been asked, answered or even fixed in the development branch.

  • Check if the issue is reproducible with the latest stable version of Pipcook. If you are using a pre-release, please indicate the specific version you are using.

  • It is required that you clearly describe the steps necessary to reproduce the issue you are running into. If the issues are asked to provide clear descriptions for more than 5 days, we will close it immediately.

  • If your issue is resolved but still open, don’t hesitate to close it. In case you found a solution by yourself, it could be helpful to explain how you fixed it.

Pull Request Guidelines

  • Only code that's ready for release should be committed to the main branch. All development should be done in dedicated branches.
  • Checkout a new topic branch from main branch, and merge back against main branch.
  • If adding new feature:
    • Add accompanying test case.
    • Provide convincing reason to add this feature. Ideally you should open a suggestion issue first and have it greenlighted before working on it.
  • If fixing a bug:
    • If you are resolving a special issue, add (fix #xxxx[,#xxx]) (#xxxx is the issue id) in your title for a better release log,
    • Provide detailed description of the bug in the PR. Live demo preferred.
    • Add appropriate test coverage if applicable.

Git Commit Specific

  • Your commits message must follow our git commit specific.
  • We will check your commit message, if it does not conform to the specification, the commit will be automatically refused, make sure you have read the specification above.

Providing Feedback

We are happy to hear any feedbacks or are delighted to ask any questions. You can join our Dingding Group or ask away on Stack Overflow using the tag Pipcook