#Provide a cover letter

Unless you are in a very technical domain, most questions around the code will not be about the 'how' but about the 'why' or the 'what'.

As such, the way to reduce people from having to look in your code, is to write a short description of it. The advantage of this is that you can compile an overview of descriptions quite easily, and that this is much more accesible. (Even to people who won't/are not allowed to see the code).

Even if people are technical, the cover letter should offer guidance of where they should be looking for something.

Simple extremely minimalistic points:

1. Introduction, why does this code (base) exist
2. What function does the code subset fulfill
3. Where is the code (script name for instance)

##Example

1. This set of scripts scrapes StackOverflow and upvotes answers by Dennis Jaheruddin
2. a. This script is responsible for parsing the html, and analyze whether it is the right user
3. a. The script is found at: ScrapeAndVote/RecognizeDennis.scr

Provide a cover letter

Unless you are in a very technical domain, most questions around the code will not be about the 'how' but about the 'why' or the 'what'.

As such, the way to reduce people from having to look in your code, is to write a short description of it. The advantage of this is that you can compile an overview of descriptions quite easily, and that this is much more accesible. (Even to people who won't/are not allowed to see the code).

Even if people are technical, the cover letter should offer guidance of where they should be looking for something.

Simple extremely minimalistic points:

1. Introduction, why does this code (base) exist
2. What function does the code subset fulfill
3. Where is the code (script name for instance)

Example

1. This set of scripts scrapes StackOverflow and upvotes answers by Dennis Jaheruddin
2. a. This script is responsible for parsing the html, and analyze whether it is the right user
3. a. The script is found at: ScrapeAndVote/RecognizeDennis.scr