Skip to content

Latest commit

 

History

History
79 lines (62 loc) · 3.67 KB

CONTRIBUTING.md

File metadata and controls

79 lines (62 loc) · 3.67 KB
Raw

Contributing to Data Umbrella Event Transcripts

Instructions for Transcribers

  1. Pick a video to transcribe (if the column Transcriber has a ?, that means it needs a transcriber.)
  2. Open an issue and indicate which video you are working on.
  3. You can start with the given YouTube preliminary text.

Requirements

  • Attention to details is very important requirement for this task.
  • Good spelling and grammar is critical to this task.
  • Being comfortable with reading, writing and listening to the English language is important for this task.
  • Helpful: It is helpful to have some familiarity with Markdown.
  • Helpful: It is helpful to know Git so a pull request (PR) can be submitted with edits.

Good Examples

Here are some examples of transcripts that are well-edited:

  1. scikit-learn Pull Request Example: 2020/06-reshama-shaikh-sklearn-pr.md
  2. Emily Robinson Career Talk: 2020/10-emily-robinson-career.md

Here is what the raw markdown file looks like:
https://raw.githubusercontent.com/data-umbrella/event-transcripts/main/2020/06-reshama-shaikh-sklearn-pr.md

Submitting Edits

You can submit edits in one of these formats:

  1. GitHub Pull Request: Edit the file on GitHub and submit a PR that way.
  2. Pull Request: Use a code editor and submit a PR (Markdown file) using command line.

Transcribing

  • For beginning of sentences, make them capital letters
    • Example: when "i" as in "i think", can you change to capital letter: "I think ..."
  • Break sections down into paragraphs (not one whole file)
  • For the sections, add some timestamps, so people know where they can find it in the video? Breaking it down every 10 minutes or so is acceptable. (That would be 6 timestamps for a 1-hour talk.)
    • Example of sub-section and timestamps
### Set Up Repository (3:46)
  • Add period to the end of sentences.
  • Fix spelling
    • Example: PY Ladies ===> PyLadies
    • Example: "data umbrella" ===> Data Umbrella
    • Example: "reishmas" ===> Reshama
  • When I did this, I listened to the video for a couple of sentences, and then stopped it. Then I edit the text and then I start the video again for another sentence or two.

Notes

  • It can take a good 2 to 4 hours to edit a transcript for a 1-hour video.
  • It is not necessary to include screenshots of slides.

Standard Header in Transcription

Here is an example of a standard header in a transcript file

# Ty Shaikh: Scraping Poshmark Data with Python

## Key Links
- Transcript:  https://github.com/data-umbrella/event-transcripts/blob/main/2020/03-ty-shaikh-webscraping.md
- Meetup Event:  https://www.meetup.com/nyc-data-umbrella/events/270285046/
- Video:  https://youtu.be/0L1uM_18TTA
- Slides:  not applicable
- GitHub repo:  https://github.com/ty-shaikh/scraping_poshmark_webinar
- Binder:  https://mybinder.org/v2/gh/ty-shaikh/scraping_poshmark_webinar/master?filepath=1-scraping_poshmark_listings.ipynb
- Transcriber:  ? [needs a transcriber]

## Transcript

FAQs

1) How long does it take to edit a full video?

Our videos typically run 1 hour in recording duration and can take 2 to 4 hours to edit.

2) Can I edit a partial video/transcript?

It is perfectly ok, and very much welcome and appreciated!, to submit edits in 10-minute segments.