Skip to content

[Documentation] Add CONTRIBUTING.md guide#71

Open
magic-peach wants to merge 1 commit into
garvit-010:mainfrom
magic-peach:main
Open

[Documentation] Add CONTRIBUTING.md guide#71
magic-peach wants to merge 1 commit into
garvit-010:mainfrom
magic-peach:main

Conversation

@magic-peach

Copy link
Copy Markdown
Contributor

Summary

This PR adds a comprehensive CONTRIBUTING.md guide to help new contributors participate effectively in the project as requested in issue #50.

Changes Made

New File: CONTRIBUTING.md

A comprehensive guide covering:

  1. Code of Conduct - Guidelines for respectful collaboration
  2. How to Contribute - Bug reports, enhancements, and pull requests
  3. Development Setup - Complete installation instructions
  4. Coding Standards - Python style guide, code organization, testing
  5. Commit Guidelines - Message format and best practices
  6. Pull Request Process - Step-by-step workflow

Key Sections

Development Setup

  • Prerequisites (Python 3.9+, FFmpeg)
  • Step-by-step installation instructions
  • Virtual environment setup
  • Environment variable configuration
  • Project structure overview

Coding Standards

  • PEP 8 compliance
  • Type hints and docstrings
  • Testing guidelines
  • Code organization principles

Commit Guidelines

  • Clear commit message format
  • Atomic commits
  • Issue references

Benefits

  • Reduces onboarding time for new contributors
  • Ensures consistent code quality
  • Clarifies contribution workflow
  • Provides reference for best practices

Closes #50

Add comprehensive contributing guidelines covering:
- Code of conduct
- Development setup instructions
- Coding standards and best practices
- Commit message guidelines
- Pull request process
- Project structure overview

This document helps new contributors understand how to
participate in the project effectively.

Closes garvit-010#50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

add contributing.md

1 participant