MPEGGroup / FileFormatConformance

MPEG File Format Conformance Framework
https://mpeggroup.github.io/FileFormatConformance/
BSD 3-Clause Clear License
10 stars 3 forks source link

improve contributing.md #95

Closed RufaelDev closed 8 months ago

RufaelDev commented 10 months ago

Summary

As discussed at the File format AhG call, some suggestions to improve contributing.md

Split section 1 in 1.1. general requirements and 1.2. json metadata 1.1. can include the zipfile naming requirements, byte size requirements (how many bytes ?) and the requirement to make an mpeg contribution 1.2 json metadata I would like to know a bit more about how to generate this with GPAC (command line), or bento and what the specific requirements on the syntax of json would be. The default option of using gpac looks strange to me as by definition new boxes are not supported in gpac otherwise they would not be new. So a contributor would really need to know how to create a metadata json file in any case. The explanation that the json is used by the search interface also helps to understand why this is needed and a requirement for contributing. I dont think it is necessary to provide too many details on how the gpac integration works in the framework. Instead, I think if people know how to create the json and they include it when contributing reference files this will help not only for the conformance framework, but also with doing cross checks as the json shows what is intended to be in the mp4 file. clause 2: If this is only intended for administrators, maybe create a separate document on how to create a pull request and reference to that? It is good to have this information, but as most people are not file format chairs including this information by reference makes sense !?

Steps to reproduce

none/open contributing.md