Skip to content

Latest commit

 

History

History
132 lines (104 loc) · 3.31 KB

CONTRIBUTING.md

File metadata and controls

132 lines (104 loc) · 3.31 KB

Contributing to Data Dialogue

First off, thank you for considering contributing to Data Dialogue! 🎉 As an AI-powered data interaction tool, we're excited to have your input in making our project even better.

Table of Contents

Project Structure

data-dialogue/
├── backend/
│   ├── app/
│   │   ├── api/
│   │   ├── core/
│   │   ├── services/
│   │   └── main.py
│   ├── Dockerfile
│   └── requirements.txt
├── frontend/
│   ├── static/
│   │   ├── css/
│   │   ├── images/
│   │   ├── js/
│   │   └── templates/
│   ├── app.py
│   └── Dockerfile
├── scripts/
│   └── black/
│       ├── setup_linux.sh
│       └── setup_windows.bat
├── docker-compose.yml
├── .gitignore
└── README.md

Code of Conduct

Our project is committed to providing a welcoming and inspiring community for all. We expect all participants to:

  • Be respectful and inclusive
  • Be collaborative
  • Focus on what is best for the community
  • Show empathy towards other community members

Development Process

  1. Fork the repository
  2. Create your feature branch from develop
  3. Write your code and tests
  4. Follow our commit message convention
  5. Push to your fork
  6. Submit a pull request

Branching Strategy

We use the following branches:

  • main: Production-ready code
  • develop: Integration branch for features
  • feature/*: New features
  • fix/*: Bug fixes
  • hotfix/*: Emergency fixes for production

Commit Convention

We use Conventional Commits to automate versioning and release notes.

Format

<type>(<scope>): <description>

[optional body]

[optional footer]

Types

  • feat: New feature (MINOR version bump)
  • fix: Bug fix (PATCH version bump)
  • docs: Documentation changes
  • style: Code style changes
  • refactor: Code restructuring
  • perf: Performance improvements
  • test: Adding/updating tests
  • chore: Maintenance tasks

Examples

# Add new LLM feature
feat(backend): add support for new LLM model

# Fix database connection
fix(database): resolve PostgreSQL timeout issue

# Breaking API change
feat!: redesign query generation API

# Update documentation
docs: update installation guide

Pull Request Process

  1. Create a PR from your feature branch to develop
  2. Ensure your PR title follows commit convention
  3. Update documentation if needed
  4. Get at least one code review
  5. All checks must pass before merging

Additional Resources

PR Title Convention

Follow the same convention as commit messages:

feat: add new language model integration
fix: resolve memory leak in query processor
docs: update deployment guide

Development Setup

Follow the instructions Development Setup