commonsearch / cosr-participation

Common Search sub-project to make contributing easy and help people get involved.
7 stars 0 forks source link

Provide context in file headers #11

Open sylvinus opened 8 years ago

sylvinus commented 8 years ago

When linking to a file (example), context can be easily lost.

For instance, in this test file, it would be great to have a header explaining how to launch the tests and what syntax/library is used to run them.

What guidelines should we adopt for this?