Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
49 lines (34 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

49 lines (34 loc) · 1.59 KB

Contributing to DeTAILS

First off, thank you for considering contributing to DeTAILS! We truly appreciate your time and effort. This document outlines our guidelines for reporting issues, proposing enhancements, and submitting pull requests.

Table of Contents

  1. Code of Conduct
  2. How Can I Contribute?

Code of Conduct

Please read and abide by our Code of Conduct. Everyone interacting in this project’s codebases, issue trackers, or social media spaces is expected to follow it.

How Can I Contribute?

Reporting Bugs

  1. Search existing issues to see if your bug has already been reported.
  2. If not, open a new issue and include:
    • A clear, descriptive title (e.g., “🛑 Electron crash when opening Settings”).
    • Steps to reproduce (including platform and version info).
    • Expected vs. actual behavior.
    • Screenshots or logs, if applicable.

Suggesting Enhancements

  1. Browse existing feature requests or discussions.
  2. Open a new “enhancement” issue with:
    • A descriptive title (e.g., “✨ Support GPU acceleration in Ollama service”).
    • Motivation and use cases.
    • High‑level design ideas or links to references.

Submitting Pull Requests

  1. Fork the repository and create a feature branch: 
    git clone https://github.com/DaemonOnCode/DeTAILS.git
cd DeTAILS
git checkout -b feat/feature