| title | Contributing Guidelines |
|---|---|
| description | We appreciate your interest in contributing to VisionFlow. This guide will help you get started. |
| type | guide |
| status | stable |
We appreciate your interest in contributing to VisionFlow. This guide will help you get started.
Be respectful, inclusive, and professional in all interactions.
- Fork the repository
- Clone your fork
- Create a feature branch
- Make your changes
- Submit a pull request
Before starting work, create an issue describing:
- Problem or feature request
- Proposed solution
- Implementation approach
Wait for maintainer feedback before implementing large changes.
feature/add-notifications
fix/resolve-upload-bug
docs/update-api-guide
refactor/improve-authFollow 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
- Update documentation
- Add/update tests
- Ensure CI passes
- Request review
- Address feedback
- Merge when approved
## 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- Follow existing patterns
- Use ESLint and Prettier
- Write meaningful comments
- Keep functions small
- Avoid magic numbers
- GitHub Issues
- Community Forum
- Email: dev@visionflow.example
Thank you for contributing!