Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?

Project Review Checklist

Initial checks

  • Quantitative
    • The source code is available at the given repository URL.
    • The Licence for the project is OSI approved.
    • The repository contains a Licence file, contributing guidelines and a README.
    • The issue tracker link has been provided.
    • The link for documentation has been provided.
    • The applicant has major contributions in the submitted project.
  • Qualitative
    • If any of the checks above are not met, or if the matter provided is insufficient, describe how.

Metric based checks

Communication Channels

Metric Question: How welcoming, responsive, respectful are interactions even on hot topics of debate? What is the diversity of voices speaking/being heard?

Quantitative

  • The communication channel available to join for new contributors.
  • The language used within the channel is clear and easy to grasp.
  • The project communication channel helps to create a diverse and inclusive environment.

Qualitative

  • How does the Communication Channel for the project create an inclusive environment?

Issue Tracker

Metric Question: How well does the project issue tracker setup to invite new contributors, skilled contributors, non-technical contributors?

Quantitative

  • The issue tracker is readable without login.
  • The issues have been labeled extensively, and the labels have accurate descriptions.

Qualitative

  • Describe how the issue tracker can be improved.

Response Times & Quality

Metric Question: How quickly and well does the project respond to suggestions, PR'S, and questions?

Quantitative

  • The project has a good (human) response time.

Qualitative

  • If the project measures response time, state how effective these measurements are in building a better environent.

Sentiment

Metric Question: What is the sentiment within external communication channels regarding our own press releases and within our internal communication channels?

Documentation

Metric Question: What is the thoroughness, and accessibility of documentation according to a set of criteria?

Quantitative

  • The documentation is screen reader accessible.
  • The documentation is searchable.
  • The document structure was easy to follow.
  • The documentation is actively maintained.
  • The documentation avoids non-inclusive language.

Qualitative

  • Describe how the Documentation of the project can be improved to resolve the checks that were not met.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment