Skip to content

Latest commit

 

History

History
63 lines (45 loc) · 4.92 KB

CONTRIBUTING.md

File metadata and controls

63 lines (45 loc) · 4.92 KB
Raw

Guidelines for Contributing

👍🎉 Firstly, we thank you for taking the time to contribute! 🎉👍

Contribution comes in many forms:

The following is a set of guidelines for contributing to ClearML. These are primarily guidelines, not rules. Use your best judgment and feel free to propose changes to this document in a pull request.

Reporting Issues

By following these guidelines, you help maintainers and the community understand your report, reproduce the behavior, and find related reports.

Before reporting an issue, please check whether it already appears here. If it does, join the on-going discussion instead.

Note: If you find a Closed issue that may be the same issue which you are currently experiencing, then open a New issue and include a link to the original (Closed) issue in the body of your new one.

When reporting an issue, please include as much detail as possible: explain the problem and include additional details to help maintainers reproduce the problem:

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps necessary to reproduce the problem in as much detail as possible. Please do not just summarize what you did. Make sure to explain how you did it.
  • Provide the specific environment setup. Include the pip freeze output, specific environment variables, Python version, and other relevant information.
  • Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/paste snippets which you use in those examples.
  • If you are reporting any ClearML crash, include a crash report with a stack trace from the operating system. Make sure to add the crash report in the issue and place it in a code block, a file attachment, or just put it in a gist (and provide link to that gist).
  • Describe the behavior you observed after following the steps and the exact problem with that behavior.
  • Explain which behavior you expected to see and why.
  • For Web-App issues, please include screenshots and animated GIFs which recreate the described steps and clearly demonstrate the problem. You can use LICEcap to record GIFs on macOS and Windows, and silentcast or byzanz on Linux.

Suggesting New Features and Enhancements

By following these guidelines, you help maintainers and the community understand your suggestion and find related suggestions.

Enhancement suggestions are tracked as GitHub issues. After you determine which repository your enhancement suggestion is related to, create an issue on that repository and provide the following:

  • A clear and descriptive title for the issue to identify the suggestion.
  • A step-by-step description of the suggested enhancement in as much detail as possible.
  • Specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples as Markdown code blocks.
  • Describe the current behavior and explain which behavior you expected to see instead and why.
  • Include screenshots or animated GIFs which help you demonstrate the steps or point out the part of ClearML which the suggestion is related to. You can use LICEcap to record GIFs on macOS and Windows, and silentcast or byzanz on Linux.

Pull Requests

Before you submit a new PR:

  • Verify the work you plan to merge addresses an existing issue (If not, open a new one)
  • Check related discussions in the ClearML slack community (or start your own discussion on the #clearml-dev channel)
  • Check your branch with helm lint
  • Update version in Chart.yaml according semver rules
  • Substitute annotations section in Chart.yaml annotating implementations (useful for Artifecthub changelog)
  • Update chart README using helm-docs

In your PR include:

  • A reference to the issue it addresses
  • A brief description of the approach you've taken for implementing