The review template is intended to assist ARFC members as they conduct reviews for journal articles. Reviewing papers is a critical service for the field, and providing clear, objective, constructive feedback is the responsibility of all experts. A well crafted review is appreciated by editors and authors alike.
This review template is written in LaTeX, so compiling it will require LaTeX to
be installed. However, often, the review is requested in a plain text format.
Converting this to markdown or word can be conducted with pandoc.
This repository should be cloned as a private repository to your own github
user space. Mine is at katyhuff/reviews. I recommend either creating a new branch for
each review you conduct or creating a folder for each review in the main
branch. I have found that keeping all of the reviews in the main branch in
separate subfolders following the naming convention
YYYY-authorlastname-titlefirstword is easiest to navigate and allows
boilerplate text to be copied easily from one review to another.
Once that is complete, each review will require that you:
- Replace the
review.bibfile with one containing bibliography entries, including the paper being reviewed, and commit it. - Open the
review.texfile and fill in the INPUT DATA section. Commit it. - Open the
review.texfile and fill in your considerations. Uncomment useful boilerplate text as needed. Commit as needed. - Build the file with pdflatex and bibtex and/or use pandoc to generate other formats.
- Save your work by committing the final pdf submitted to the journal.
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update the readme as appropriate.