HackAnalysis

A list of methods and a workflow to validate, review and create reports for Hackathon projects.

edit

---

Table of Contents

• Scope
• Validation categories
• Displays/Reports
• Manual tasks
• Companion tools

---

Scope

Create a Report for a Git project according to the workflow below.

1. Get a list of the software used (name, type, link).
2. Find frameworks used.
3. Get the licenses for each dependency used. Are there any non-free software used without mention it?
4. Search for “similar” repos (projects) on Google, GitHub, Gitlab etc (title, code pieces, funcionality, tags).
5. Show commits timeline by author with visualization (use GitHub Pulse).
6. Check all the required files are included (License, README with installation info, db file).
7. Follow the instructions and check the project can be installed (reproduce locally).
8. Check media used (eg demo images, logos etc) have a propriate license (copyright issues).
9. Make a Static Code (Software) Analysis (for the main project language).
10. Are there any commits during the “forced break”?

Validation categories

Basic characteristics to Validate (or take into consideration).

• Usage of a Framework(s)
• REST API, SDK, SOAP etc
• Responsive Design
• Administration
• Member accounts and personalization
• Documentation
• 3rd Party integrations
• Platforms available
• Consume or produce open data
• MVP status
• New and cutting edge technologies used
• Cross platform
• Database queries quality

Displays/Reports

1. One page HTML
2. PDF file (from HTML)

Manual tasks

1. Clone the repo locally
2. Follow the installation instructions
3. Check functionality, eg:
   • Basic usage
   • Login forms
   • Console log errors
   • Behavior on small screens and mobile devices
   • Browser support

Companion tools

Git repository analysis

• git_stats
• git-stats
• gitstats
• gitinspector

Offline

• Qafoo - QualityAnalyzer
• Awesome Static Analysis
• Sitespeed.io

Online

• codacy.com
• codeclimate.com