enhancement request for contributing instructions
villares opened this issue · 0 comments
villares commented
I found the instructions at https://github.com/pyvideo/data/blob/main/CONTRIBUTING.rst a bit daunting. Could someone familiar with the contributing process help write an introductory paragraph describing what is expected/necessary?
After reading :
- Run your tests locally by activating your venv and running make test
- Address any test failures. Common test failures from the youtube import process come from unescaped special characters and odd description formatting.
It looks like I have to check and install requirements? Where are the requirements? will it work on any OSs?
What is this youtube import process? Where/when will it happen?
I wish there was something a bit like this:
So you want to add a video from a Python community event to pyvideo.org? This is how it works: (overview)
Go to the Adding Data section
- You'll need to prepare a JSON file for the video, follow the example shown
- Fork and clone this repo to add your JSON file
- Files are organized in category-folders (usually per event) if no appropriate category-folder exists you should create one.
- Otherwise add the file to videos folder inside the category folder
- You'll need X tools in your computer
- The video file will come from Y on Z and you should/shouldn't worry about W
- You'll make a PR and we'll help you fix it if something is wrong.