Skip to content
Snippets Groups Projects
CONTRIBUTING.md 1.46 KiB
Newer Older
Yakubov, Sergey's avatar
Yakubov, Sergey committed
# Contributing to Time Resolved Visualization

Thank you for considering contributing to Time Resolved Visualization!
This document provides guidelines to help you contribute effectively and ensure a smooth process for everyone involved.

## Getting Started

To start contributing to this project, you will need an ORNL's GitLab account.
If you are unfamiliar with GitLab or version control,
consider reviewing GitLab's [Documentation](https://docs.gitlab.com/).

## How to Contribute

### Reporting Bugs

If you find a bug in the project, please open an issue on GitLab with a clear and concise description. Make sure to include:

- Steps to reproduce the bug.
- Expected behavior.
- Actual behavior.
- Any relevant screenshots, logs, or stack traces.

### Suggesting Features

We welcome feature suggestions! To propose a new feature:

1. Open an issue on GitLab with the title "Feature Request: [Feature Name]".
2. Provide a detailed description of the proposed feature.
3. Explain why this feature would be useful for the project.
4. Include any relevant examples or mockups.

### Submitting Changes

If you'd like to contribute code changes, please follow the following guidelines:

- [Working on a feature](https://calvera.ornl.gov/docs/dev/project_management/gitlab/single-repo/)
- [Style guidelines](https://calvera.ornl.gov/docs/dev/project_management/style_guidelines/)

## Code of Conduct

Please adhere to the project's [Code of Conduct](CODE_OF_CONDUCT.md) in all interactions.