Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
58 lines (44 loc) · 1.68 KB

CONTRIBUTING.md

File metadata and controls

58 lines (44 loc) · 1.68 KB

Contributing to TranscodePy

Thank you for considering contributing to TranscodePy! Contributions are welcome and appreciated. By participating in this project, you agree to abide by the Code of Conduct.

How to Contribute

  1. Fork the Repository:

    • Use the "Fork" button at the top-right of the repository page to create your copy of the project.

  2. Clone the Repository:

    git clone https://github.com/<your-username>/transcode-py.git
cd transcode-py

  3. Create a Branch:

    • Use a descriptive branch name for your changes:
    git checkout -b feature/your-feature-name

  4. Make Changes:

    • Follow the project structure and coding standards.
    • Write unit tests for new or modified functionality.

  5. Run Tests:

    • Ensure all tests pass:
    python -m unittest discover -s tests

  6. Commit Your Changes:

    • Use clear and concise commit messages:
    git add .
git commit -m "Add feature X or fix bug Y"

  7. Push Your Changes:

    git push origin feature/your-feature-name

  8. Create a Pull Request:

    • Go to the original repository.
    • Click on "Pull Requests" and submit your PR.
    • Provide a clear description of your changes and reference any relevant issues.

Guidelines

  • Follow PEP 8 for Python coding standards.
  • Write meaningful commit messages.
  • Keep pull requests focused on one topic.
  • Ensure your changes do not break existing functionality.

Code of Conduct

We follow the Contributor Covenant Code of Conduct. Be respectful and considerate in all interactions.