Skip to content

Commit a800190

Browse files
committed
Add EXECUTIVE_SUMMARY.md document
To comply with OPENNEXT review requirements.
1 parent d4afca6 commit a800190

2 files changed

Lines changed: 23 additions & 0 deletions

File tree

.reuse/dep5

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ Source: https://github.com/OPEN-NEXT/wp2.2_dev/
55

66
Files:
77
README.md
8+
EXECUTIVE_SUMMARY.md
89
.github/ISSUE_TEMPLATE/bug_report.md
910
docs/images/dashboard_flowchart.drawio.jpg
1011
docs/images/dashboard_flowchart.drawio.svg

EXECUTIVE_SUMMARY.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Executive summary
2+
3+
The work presented here is an *initial* demonstrator delivered at month 18 of the [OPENNEXT](https://opennext.eu/) project as part of task 2.2: "Creating a design process facilitation dashboard" (deliverable number 2.3). This work is part of work package 2, and is the primary responsiblity of the OPENNEXT academic partner at the University of Bath (UBA) in the United Kingdom. It is to establish the foundational infrastructure on which the ambition to facilitate company-community collaboration on open source hardware projects can be pursued.
4+
5+
To that end, this deliverable contains two primary components:
6+
7+
1. A [Git](https://git-scm.com/) version control repository containing 15,000 lines of Python scripts: https://www.github.com/OPEN-NEXT/wp2.2_dev/ This source code is composed of (a) a data-mining Python module (`osmine`) which mines publicly-viewable metadata from a user-supplied list of open source [version control](https://en.wikipedia.org/wiki/Version_control) repositories; and (b) an interactive [Dash](https://dash.plotly.com/)-based web module (`osdash`) that computes and visualises basic metrics on those repositories. For the purposes of OPENNEXT, the list of open source repositories would eventually be those in use by the OPENNEXT small and medium enterprises (SMEs) partners for their open source hardware development work.
8+
9+
2. A live demo instance of `osdash` which can be visited here: https://opennextwp22.eu.pythonanywhere.com/ This illustrates basic elements of interactive data visualisations based on data retrieved from the version control repositories of open source projects. It is meant to serve as a base for what future visualisations of data analyses on open source project health metrics.
10+
11+
The primary results of this deliverable are that:
12+
13+
* The Python codebase is functionally complete providing the capabilities described above. Notably, it adheres to several international standards and best practices on open source software development including, but not limited to: the [Software Package Data Exchange](https://spdx.dev/) (SPDX) format; [REUSE standard](https://reuse.software/) for open source licensing; using a README file as the primary documentation that follows the [Standard Readme Specification](https://github.com/RichardLitt/standard-readme); and the [Contributor Covenant](https://www.contributor-covenant.org/) Code of Conduct for participants.
14+
* The live demo shows examples of how project metadata can be visualised, which will serve as the basis for collaboration with and getting input from SME partners on what metrics on project health would be most helpful for their open source hardware efforts.
15+
16+
With this foundation, we hope to:
17+
18+
* Investigate community collaboration patterns in open source development by analysing the file-change histories of their version control repositories.
19+
* Work with other work packages and SME partners to identify project health metrics and assess which ones are suitable for an interactive dashboard based on quantitative data.
20+
* Continue technical improvements to the underlying Python code.
21+
22+
For review purposes, please note the primary documentation for this deliverable - with more detailed and thorough descriptions of its background, design, installation, and usage - is the industry-standard README file contained in its Git repository, which can be viewed here: https://www.github.com/OPEN-NEXT/wp2.2_dev/

0 commit comments

Comments
 (0)