document a code comment tag that indicates modifications about network-api

[Pomax]

I'd suggest override: start #12345 in that case (with corresponding end) where 12345 is an issue number. That way custom code can always be traced back to the "why" at the project level.

[Pomax]

/cc @alanmoo @cadecairos @arush0311

[Pomax]

This will require updating several files that we already made modifications to in the app/networkapi/static as well as the app/networkapi/templates directories

[arush0311]

Additional, we should also have code comments following any override: start that explain the modification

@Pomax In my case the overridden content was several blocks of lines in different places, all collectively doing one thing. What about override: start <keyword> and we explain those keywords at top of file? Also I think we should also comment out the removed content instead of deleting them

[Pomax]

added to the readme

[alanmoo]

@gvn something for MoFo standards maybe?

[gvn]

Yeah that seems reasonable, although fairly domain specific if it's just regarding Mezzanine?

[Pomax]

I guess the idea is mezzanine here, but for any framework that we use where we need to "monkey patch" (I know that's not what this is, technically, but taking a 2000 line file and updating 10 lines sure feels like it =D) it's good to know there's one particular style we use, modulo the actual comment syntax (<!-- ... --> vs # ... vs ''' ... ''' vs /* ... */ vs {# ... #} vs etc. etc.)