README

   1 Welcome to the metrics-tasks code repository!
   2
   3 This repository contains technical reports and code snippets for metrics
   4 analyses.  Most of this code was written with the single purpose of
   5 answering a metrics question.  Once it's answered, we're done.  But the
   6 code should be somewhere in case we want to answer a similar question in
   7 the future.  And this "somewhere" shouldn't be someone's desktop.
   8
   9 The rules are simple:
  10
  11  - Whenever we feel like we want to share technical report sources or
  12    Java, R, Python code for metrics analyses, we create a new subdirectory
  13    here.  The naming convention is simply that we use the ticket number
  14    that Trac assigns as subdirectory name.  For example, code for ticket
  15    #1234 should go in subdirectory task-1234/.  If there's no Trac ticket
  16    yet, then why are you working on it?  Go create a Trac ticket first!
  17
  18  - There should be a README file in every subdirectory saying what the
  19    code does, what libraries are required, and so on.  Don't spend much
  20    time on writing a good README, but imagine that you might want to know
  21    what's going on in 3, 6, or 12 months.
  22
  23  - Don't check in binaries.  We assume that whoever checks out code from
  24    this repository knows how to download libraries and compile sources.
  25
  26  - If we open a follow-up ticket to a ticket that has code in this
  27    repository, we `git mv` the files and create a tiny text file in the
  28    original ticket directory saying where the code moved.
  29
  30  - The code in a ticket may never rely on the code of another ticket in
  31    this repository.  Consider the subdirectories as small projects that we
  32    were just too lazy to create new Git repositories for.  Other than that
  33    subdirectories here have nothing in common.
  34
  35 So much about the rules.  Now go answer fine metrics questions!
  36