What code can be reviewed?

Code reviews can be pretty time consuming. When requesting a review, please only submit requests for code that can be understood and reviewed in roughly an hour. This means, at this point, we can't accept requests for extensive libraries and whole desktop or web applications.

General requirements

To effectively review your code, please make sure the following conditions are met:

• Your repository is publicly available.
• There is a LICENSE file in the repository.
• Documentation is available and clearly accessible (e.g. a README file in the repository).
  • The documentation contains installation instructions.
  • The documentation contains a description of what problem the code solves and its functionality.
• Example data is available.

How to submit a review request?

When getting ready to submit code for a review, please make sure to have the following information available (you will need them for the submission form):

• Link to the GitHub repository that contains the code to be reviewed. Ideally the repository would only contain the code that should be reviewed. If, however, there is more code that shouldn't be reviewed please note so in the form. What is the utilized programming language?
• Who are the authors and contributors and what did they contribute? What are the roles of the submitters?
• Are there supporting papers (that, for example, describe employed algorithms)?
• For which field was the code developed?
• Are there any standards the reviewer should know? Is there any other domain knowledge required?
• Are there any requirements that need to be fulfilled for the code to run (e.g. hardware requirements, OS requirements, etc)?
• Anything else we need to know?