Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
101 lines (65 loc) · 2.75 KB

CONTRIBUTING.md

File metadata and controls

101 lines (65 loc) · 2.75 KB
Raw

Contributing to ChatVector-AI

🤝 First Time Contributing? Welcome!

There is a range of tasks for beginners to more advanced developers

This guide will walk you through the process step-by-step.

Start Here:

  1. Check the issues tab: good first issue - These are specially tagged for beginners
  2. Check the Project Board - See what's being worked on
  3. Found a bug? Open an issue and fix it!
  4. Have an idea? Start a Discussion first

Still Unsure?

  1. Comment on an issue

  2. Ask for help in - Discussions

  3. We'll help you find the perfect first contribution

📝 Branch and Commit Naming Convention

Format: type/description

Types:

  • feat/ - New features (e.g., feat/add-dark-mode)
  • fix/ - Bug fixes (e.g., fix/upload-error-handling)
  • docs/ - Documentation (e.g., docs/update-readme)
  • refactor/ - Code restructuring (e.g., refactor/backend-modules)

Quick checklist:

  • Branch name follows convention
  • Commits are focused and descriptive

Maintainers should review and merge according to project policy.

Variable Naming

Python:

# 👍 Good - Type hints and docstrings
def process_document_chunks(document_text: str) -> list[str]:
    """Split document into chunks for processing."""
    pass

# 👎 Avoid - Unclear purpose
def chunk(

PR Process

Check the Readme - For instructions on project setup

1. Create Your Feature Branch

Follow the branching workflow described here:

📄 See: `development.md → Creating a new feature branch`

This document focuses on contribution rules and expectations.

2. Open Pull Request

  1. Go to YOUR fork: github.com/YOUR_USERNAME/chatvector-ai
  2. Look for: "Your recently pushed branches: feat/your-feature-name"
  3. Click "Compare & pull request"
  4. This creates PR from your fork → original repo

3. Fill PR Description

## What does this PR do?

## How was it tested?
- [ ] Tested locally with FastAPI `/docs`
- [ ] Checked existing functionality still works

## Screenshots (if UI changes):

🎯 Before Submitting

  1. Test your changes manually using FastAPI /docs
  2. Verify existing functionality still works
  3. Check your code runs without errors
  4. Update documentation if needed