qri-io / .github

MIT License
0 stars 0 forks source link

Standardize comment warning about machine-generated files #7

Open feep opened 4 years ago

feep commented 4 years ago

Qri machine-generates a lot of code, docs...

The heavily-bikeshedded go standard looks good to me.

A standard comment format would be easily greppable and cooperate with existing code tooling like linguist.

Generated files are marked by a line of text that matches the regular expression, in Go syntax: ^// Code generated .* DO NOT EDIT\.$ The .* means the tool can put whatever folderol it wants in there, but the comment must be a single line and must start with Code generated and end with DO NOT EDIT., with a period.

The text may appear anywhere in the file.

feep commented 4 years ago

This comment should be followed by additional comments specifying: