Skip to content

Latest commit

 

History

History
94 lines (64 loc) · 4.2 KB

factoid.md

File metadata and controls

94 lines (64 loc) · 4.2 KB
Raw

Factoid

A Factoid is a short, high-level bullet point delivering a simple observation about a Project. Factoids are derived from an Analysis, and new Factoids are created for a Project every time a new Analysis is created.

On the Ohloh web site, Factoids are rendered in the Nutshell section of the project summary page. Factoids also are available in several of the sharing widgets available for embedding on websites.

A Project has factoids only if Ohloh has downloaded and analyzed its source code.

Properties

  • id The unique ID for the Factoid. Factoid IDs change every time the Project is reanalyzed, so it’s unwise to store these IDs for long periods.

  • analysis_id The unique ID of the analysis used to calculate this factoid.

  • type The Factoid type. The possible types are defined below.

  • description A short, human-readable description. This is the bullet point text which appears on the Ohloh project page.

  • severity An integer from -3 to +3 which rates the relative severity of the factoid. Negative numbers generally indicate bad news, positive numbers generally indicate good news. Ohloh uses these numbers to select icons to display beside the factoids. All factoids of the same type have the save severity.

URL

To get a single Factoid:

curl https://www.openhub.net/projects/{project_id}/factoids/{factoid_id}.xml

Collection URL

To get a list of all current Factoids for a particular Project:

curl https://www.openhub.net/projects/{project_id}/factoids.xml

The collection request does not support any filtering, sorting or paging. You will always receive the entire collection of factoids, ordered by descending priority.

Factoid Types

  • FactoidActivityDecreasing During the last twelve calendar months, there were at least 25% fewer commits to this project than in the prior twelve calendar months.

  • FactoidActivityStable During the last twelve calendar months, the commit count was within +/- 25% of the count for the prior twelve calendar months.

  • FactoidActivityIncreasing During the last twelve calendar months, there were at least 25% more commits to this project than in the prior twelve calendar months.

  • FactoidAgeYoung The source control repository is less than 1 year old.

  • FactoidAgeEstablished The source control repository is 1 to 3 years old.

  • FactoidAgeOld The source control repository is 3 to 5 years old.

  • FactoidAgeVeryOld The source control repository is 5 years old or older.

  • FactoidCommentsVeryLow Compared to all other projects written in the same language, the comment ratio for this project is in the bottom 10%.

  • FactoidCommentsLow Compared to all other projects written in the same language, the comment ratio for this project is in the bottom 33% but not in the bottom 10%.

  • FactoidCommentsAverage Compared to all other projects written in the same language, the comment ratio for this project is in the middle 33%.

  • FactoidCommentsHigh Compared to all other projects written in the same language, the comment ratio for this project is in the top 33% but not in the top 10%.

  • FactoidCommentsVeryHigh Compared to all other projects written in the same language, the comment ratio for this project is in the top 10%.

  • FactoidTeamSizeZero No commits were made to this project in the last 12 months.

  • FactoidTeamSizeOne Only a single contributor made commits to this project in the last 12 months.

  • FactoidTeamSizeSmall Two or three contributors made commits to this project in the last 12 months.

  • FactoidTeamSizeAverage 4 to 6 contributors made commits to this project in the last 12 months.

  • FactoidTeamSizeLarge 7 to 27 contributors made commits to this project in the last 12 months.

  • FactoidTeamSizeVeryLarge 28 or more contributors made commits to this project in the last 12 months.

Note about "mostly written in" - "... is mostly written in" bullet point listed in the Nutshell section of project summaries and in widgets displaying factoid information is not technically a factoid. This element is actually the main_language_name property on an analysis.