Skip to content

Latest commit

 

History

History
32 lines (18 loc) · 2.18 KB

CONTRIBUTING.md

File metadata and controls

32 lines (18 loc) · 2.18 KB

GDC-transcript Contributing Guide

Hi! We are really excited that you are interested in contributing to GDC-transcipt. Before submitting your contribution though, please make sure to take a moment and read through the appropriate section for the contribution you intend to make:

Issue Reporting Guidelines

  • The issue list of this repo is exclusively for bug reports and feature requests (i.e. requesting for new transcription or tool function). Non-conforming issues will be closed immediately.

  • Transcription and translation error definitely exists so please don't open an issue for that, help us fix it instead!

  • Try to search for your issue, it may have already been asked for.

  • If your issue is resolved but still open, don’t hesitate to close it.

  • Most importantly, we beg your patience: this is a side project that takes time and money to process. The issue list is not paid support and we cannot make guarantees about how fast your issue can be resolved.

Pull Request Guidelines

  • Please do not review the transcripts directly, review the subtitles instead. Transcripts can be generated from subtitles but not the other way around. We will be reviewing this process in near future.

  • It's OK to have multiple small commits as you work on the PR - we will let GitHub automatically squash it before merging.

  • If fixing a bug:

    • If you are resolving an issue, add (fix: #xxxx[,#xxx]) (#xxxx is the issue id) in your PR title for clarity, e.g. fix: added transcription for [YouTube_Video_ID] (fix #3899).
    • If you reviewed a transcript, add review: [YouTube_Video_ID] or review: [YouTube_Video_Name] ([YouTube_Video_ID]) in your PR title for clarity, e.g. review: c2YRVWZupwo or review: Integrating Narrative into Game Design: A Portal Post-Mortem (c2YRVWZupwo).

Financial Contribution

GDC-transcript uses Whipser's large model to transcribe for best accuracy which costs money, extra tools take time to develop. The ongoing development and transcription of the project can be supported via KoFi.