Write a formal standards file

[khannotations]

• Style for commenting functions and files
• Style for commenting confusing parts of code
• TODO() and NOTE() syntax
• Conventions about:
  • How to make CSS classes
  • Naming variables
  • Anything else?

[pfletcherhill]

How about just creating a wiki page for these standards instead of putting them in the actual codebase?

[khannotations]

That's a good idea! Will do :)

On Sat, Jun 22, 2013 at 12:33 PM, Paul Fletcher-Hill < notifications@github.com> wrote:

How about just creating a wiki page for these standards instead of putting them in the actual codebase?

— Reply to this email directly or view it on GitHubhttps://github.com/pfletch1023/Gandalf/issues/58#issuecomment-19863411 .

[khannotations]

The wiki page now has a coding standards file. If you disagree with anything, let's discuss and change it.

I propose the following workflow for documenting so that we don't have to sit for 2 hours tediously commenting shit:

• Whenever you want a break, or feel extra great, go comment some functions.
• Whenever you find yourself looking at a function, squinting and cursing to try and figure out what it does, add the relevant comments so you don't have to do that again.
• In general, whenever you edit / look at the source of a function or a file, add the necessary comments.
• Add comments to all new functions and files.

Cool? I'm gonna go work on other things now, and consider this well in progress.