Skip to content

Latest commit

 

History

History
109 lines (79 loc) · 2.06 KB

File metadata and controls

109 lines (79 loc) · 2.06 KB
title Contributing Guidelines
description We appreciate your interest in contributing to VisionFlow. This guide will help you get started.
type guide
status stable

Contributing Guidelines

Welcome Contributors!

We appreciate your interest in contributing to VisionFlow. This guide will help you get started.

Code of Conduct

Be respectful, inclusive, and professional in all interactions.

Getting Started

  1. Fork the repository
  2. Clone your fork
  3. Create a feature branch
  4. Make your changes
  5. Submit a pull request

Development Process

1. Create an Issue

Before starting work, create an issue describing:

  • Problem or feature request
  • Proposed solution
  • Implementation approach

2. Discuss Approach

Wait for maintainer feedback before implementing large changes.

3. Branch Naming

feature/add-notifications
fix/resolve-upload-bug
docs/update-api-guide
refactor/improve-auth

4. Commit Messages

Follow Conventional Commits:

feat(api): add notification endpoints
fix(web): resolve file upload timeout
docs(readme): update installation steps

Types: feat, fix, docs, style, refactor, test, chore

5. Pull Request Process

  1. Update documentation
  2. Add/update tests
  3. Ensure CI passes
  4. Request review
  5. Address feedback
  6. Merge when approved

Pull Request Template

## Description
Brief description of changes

## Type of Change
- [ ] Bug fix
- [ ] New feature
- [ ] Breaking change
- [ ] Documentation update

## Testing
- [ ] Unit tests added/updated
- [ ] Integration tests added/updated
- [ ] Manual testing completed

## Checklist
- [ ] Code follows style guidelines
- [ ] Self-reviewed code
- [ ] Commented complex code
- [ ] Updated documentation
- [ ] No new warnings
- [ ] Tests pass locally

Code Style

  • Follow existing patterns
  • Use ESLint and Prettier
  • Write meaningful comments
  • Keep functions small
  • Avoid magic numbers

Questions?

Thank you for contributing!