Skip to content

How much should I record?

petermr edited this page Jun 13, 2020 · 1 revision

Since we have 5 (or even more) interns, many will be doing the same tasks. It's always worth recording what you did and what happened. Things that vary include:

  • non-reproducible errors (e.g. server off line)
  • timings (very valuable to see the spread of this).
  • exact number of hits. EPMC is constantly updated so you may all get slightly different results.
  • warnings. It may be that the site is undergoing maintenance and warns you. EPMC seems to have non-open papers - no idea why. Maybe a getpapers bug.
  • operating system differences. filenames, directory structures vary.

If you are doing a standard procedure then you may be able to write "I installed ami using the instructions from ". But summarise your finding.

It's not always easy to get the right balance between conciseness and completeness, but generally include too much rather than 2 little. It doesn't cost anything and may be helpful.

Avoid: "I couldn't install AMI"

This tells us nothing.

Write an issue, for example

"installing ami: cannot find POM"

I checked out ami into my/programs/ with

git clone https://github.com/petermr/am3.git

then

cd
mvn install 

and I get

[INFO] Scanning for projects...
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  0.076 s
[INFO] Finished at: 2020-06-13T14:46:57+01:00
[INFO] ------------------------------------------------------------------------
[ERROR] The goal you specified requires a project to execute but there is no POM in this directory (/Users/pm286). Please verify you invoked Maven from the correct directory. -> [Help 1]
[ERROR] 

Answer: You are not in the correct directory. Try

cd my/programs/ami3
mvn install -Dtests.skip=true
Clone this wiki locally