Add a comment for empty dist files #1329
Conversation
This is to have something to search for, and another step towards always having a dist file.
| @@ -2,3 +2,5 @@ | |||
| # Do not edit this file by hand. Edit the source file instead! | |||
|
|
|||
| {} | |||
|
|
|||
| # Nothing is generated, nothing to see here. | |||
There was a problem hiding this comment.
What do you think of linking out to some documentation (you can just stub a heading for now, if you like) to handle the whole "why is it empty?" question?
There was a problem hiding this comment.
A link to https://github.com/web-platform-dx/web-features/blob/5f17741fd7c73119a8e25270ca2070d04d73cc0c/docs/CONTRIBUTING.md#feature-dist-files after it's landed, perhaps?
There was a problem hiding this comment.
Although, maybe it's better to link to the docs at the top of all dist files?
There was a problem hiding this comment.
I agree with this. Linking to the docs on line 3 of all dist files (right after asking people not to edit the file by hand) would give them a friendly way to learn more, especially for folks who prefer to jump in the code first, and read docs later.
This is to have something to search for, and another step towards always
having a dist file.