Call-for-Code / Call-for-Code/Prometeo-Pyrrha

High-level overview/diagram of the software architecture for Open Source (OS) contributors [software steel-thread]

Open
#97 0 comments 0 reactions 0 assignees View on GitHub
architect-advisor developer documentation epic-software-steel-thread tester-qa
Dominant language
JavaScript
Stars
27
Forks
18
PR merge metrics
No merged PRs in 30d

Description

"As an Open Source (OS) contributor, I need a high-level overview of the software architecture so that I can understand how to implement any enhancements or defect fixes that I want to contribute."

These 'Open Source Contributors' include us Prometeo team members :-)

* Publish a software architecture Enablement doc in the Prometeo GitHub repo
* Include a high level overview diagram and brief description ('less is more' - brief is easier for readers)
* Maybe show how a sensor reading gets from an API to the dashboard -worked examples always help
* (simulation story #94 will also add documentation here describing how to generate simulated sensor data for testing)

Subsequent epics will add more substance to this Enablement doc and flesh out the worked examples.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.