Skip to content

Latest commit

 

History

History
116 lines (84 loc) · 3.42 KB

CONTRIBUTING.md

File metadata and controls

116 lines (84 loc) · 3.42 KB
Raw

Here's a well-structured CONTRIBUTING.md file for the grpc-ffmpeg project:

Contributing to grpc-ffmpeg

Thank you for your interest in contributing to the grpc-ffmpeg project! We welcome contributions of all kinds, including bug reports, feature requests, code contributions, documentation updates, and more.

To make the contribution process smooth, please follow these guidelines.

Table of Contents

Getting Started

  1. Fork the repository to your GitHub account.
  2. Clone the forked repository to your local machine: 
    git clone https://github.com/YOUR_USERNAME/grpc-ffmpeg.git
cd grpc-ffmpeg
  3. Set up the development environment by following the Setup Guide.

How to Contribute

Reporting Bugs

If you encounter a bug:

  • Check existing issues: Look at the issue tracker to see if the bug has already been reported.
  • Create a new issue: If the bug is not reported, open a new issue and include:
    • A clear and descriptive title.
    • Steps to reproduce the issue.
    • Expected and actual behavior.
    • Environment details (e.g., OS, Python version, FFmpeg version).

Suggesting Features

If you have an idea for a feature:

  • Check the issue tracker to see if the feature has already been requested.
  • If not, open a new issue with:
    • A detailed explanation of the feature.
    • Why it would be useful.
    • (Optional) Examples of how it might work.

Submitting Code

We accept pull requests for:

  • Bug fixes.
  • New features.
  • Documentation improvements.
  • Performance enhancements.

Development Workflow

  1. Create a Branch: Create a new branch for your work:

    git checkout -b feature/your-feature-name

  2. Make Changes: Follow the Coding Standards when writing code.

  3. Commit Changes: Write clear and concise commit messages:

    git commit -m "Add feature: description of feature"

  4. Push Changes: Push your branch to your fork:

    git push origin feature/your-feature-name

  5. Create a Pull Request: Open a pull request against the main branch on the original repository.

Coding Standards

  • Python Style Guide: Follow PEP 8.
  • Naming Conventions:
    • Use snake_case for variables and functions.
    • Use PascalCase for classes.
  • Code Formatting: Use black as formatter to maintain consistent formatting: 
    black .

Pull Request Checklist

Before submitting a pull request, ensure you:

  • Followed the Coding Standards.
  • Added or updated relevant documentation.
  • Addressed any feedback from code reviews.

We appreciate your contributions and look forward to working with you!