clearml/docs/contributing.md

# Guidelines for Contributing

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

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

## Reporting Bugs

This section guides you through submitting a bug report for TRAINS. 
By following these guidelines, you 
help maintainers and the community understand your report, reproduce the behavior, and find related reports. 

Before creating bug reports, please check whether the bug you want to report already appears [here](link to issues). 
You may discover that you do not need to create a bug report. 
When you are creating a bug report, please include as much detail as possible.
 
**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.

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  TRAINS 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](https://help.github.com/en/articles/getting-started-with-writing-and-formatting-on-github#multiple-lines), 
a [file attachment](https://help.github.com/articles/file-attachments-on-issues-and-pull-requests/), or just put it in a [gist](https://gist.github.com/) (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](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [silentcast](https://github.com/colinkeenan/silentcast) or [byzanz](https://github.com/threedaymonk/byzanz) on Linux.

## Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for TRAINS, including 
completely new features and minor improvements to existing functionality. 
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](https://help.github.com/articles/markdown-basics/#multiple-lines).
* **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 TRAINS which the suggestion is related to. You can use [LICEcap](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [silentcast](https://github.com/colinkeenan/silentcast) or [byzanz](https://github.com/threedaymonk/byzanz) on Linux.