smilner added a new comment to an issue you are following:
``
Container review process contains this sentence:
Required files should be:
* Dockerfile
* help.md file
I don't personally understand whether it's a must-have or should-have. It is also
inconsistent with container guidelines because those talk about help.1 and README.md.
I totally agree. I believe we should be as specific as we can be to give a consistent help
system to users. Being explicit on the help guide would go a long way.
In my mind there should be two files:
- ``README.md``: gives a quick description/overview. This is more open ended.
- ``help.md``: gives ``man`` like information. This should be strict.
The structure of ``help.md`` should be based of a standard template that is filled out for
the specific image.
``
To reply, visit the link below or just reply to this email
https://pagure.io/atomic-wg/issue/354