Skip to content

contribution.md

Latest commit

 

History

History
55 lines (38 loc) · 1.97 KB

contribution.md

File metadata and controls

55 lines (38 loc) · 1.97 KB

✅ Commit Types

Use the following types to categorize your commits:

  • feat: Introducing a new feature (feat: Add support for multi-language transcripts)
  • fix: Fixing a bug (fix: Resolve issue with empty transcripts)
  • docs: Updating documentation (docs: Improve README.md with setup instructions)
  • style: Code style changes (formatting, indentation, missing semicolons)
    • No logic changes (style: Format HTML structure properly)
  • refactor: Code restructuring without changing functionality (refactor: Optimize Flask routing)
  • perf: Performance improvements (perf: Reduce API call latency)
  • test: Adding or updating tests (test: Add unit tests for transcript fetch)
  • chore: Routine tasks like package updates (chore: Update Flask version in requirements.txt)
  • ci: Changes related to CI/CD (ci: Configure GitHub Actions for automated testing)

📌 Branch Naming Convention

To keep things structured, follow this naming format:

✅ Examples:

  • feat/add-transcript-download
  • fix/fix-invalid-video-id
  • docs/update-readme
  • chore/update-requirements

🔄 Pull Request Guidelines

Before submitting a PR:

  1. Ensure your code is formatted and follows best practices.
  2. Run tests and verify that they pass.
  3. Keep PRs small and focused on a single feature or bug fix.
  4. Use clear commit messages and add meaningful PR descriptions.
  5. Add relevant documentation for new features.

🎯 Best Practices

✔️ Write meaningful commit messages
✔️ Avoid committing large, unrelated changes
✔️ Squash commits if necessary for a clean history
✔️ Always create a new branch for features/fixes
✔️ Keep PRs small and review-friendly

Following these guidelines ensures that the repository remains professional, structured, and easy to collaborate on.

Happy coding! 🚀