Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
26 lines (19 loc) · 1.58 KB

CONTRIBUTING.md

File metadata and controls

26 lines (19 loc) · 1.58 KB
Raw

Contrituting to Carnot

We welcome contributions from the community to help improve Carnot! Please follow the guidelines below for details on how to:

  • Report bugs
  • Suggest features
  • Submit code changes

General Guidelines

  • When creating a pull request, please be sure to specify which issue(s) your PR addresses by adding Closes #<issue-id> at the end of the PR description. This helps our automation track the progress of issues.

Reporting Bugs

If you encounter a bug while using Carnot, please open an issue on our GitHub repository. Include a clear description of the problem, steps to reproduce it, and any relevant logs or screenshots.

Also be sure to tag your issue with the "bug" label.

Suggesting Features

To suggest a new feature, please open an issue on our GitHub repository. Provide a detailed description of the feature, its benefits, and -- if possible -- how it addresses your use case (this helps us better understand the motivation behind the feature).

Please tag your issue with the "enhancement" label.

Submitting Code Changes

We use a pull request (PR) workflow for managing code contributions. Follow these steps to submit your changes:

  1. Fork the Carnot repository on GitHub.
  2. Make your changes in a branch in your fork.
  3. Create a pull request against the dev branch of the main Carnot repository. Be sure to specify which issue(s) your PR addresses by adding Closes #<issue-id> at the end of the PR description.

We will then work with you to review and merge your changes.