You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Clarifies how practice feedback and Heph support learning from project work, and identifies the project's Applied Education Technologies and TUM origins.
Copy file name to clipboardExpand all lines: README.md
+9-5Lines changed: 9 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@
6
6
</picture>
7
7
8
8
<h1>Hephaestus</h1>
9
-
<p><strong>Feedback on how you work</strong></p>
9
+
<p><strong>Learn from the work you're already doing</strong></p>
10
10
11
11
<p>
12
12
<a href="https://hephaestus.aet.cit.tum.de"><img alt="Open the TUM-operated Hephaestus web app" src="https://img.shields.io/badge/web_app-open-493C83"></a>
@@ -21,7 +21,7 @@
21
21
</p>
22
22
</div>
23
23
24
-
Hephaestus gives developers feedback on the engineering practices they use in software projects. It draws on evidence from tools the team already uses — including GitHub or GitLab activity, selected Slack channels, and Outline documents — to explain what worked, what could improve, and what to try next.
24
+
Hephaestus uses AI to give developers feedback on engineering practices in their project work. Feedback points to the work that prompted it and explains what worked, what could improve, and what to try next. Developers can discuss it with Heph, Hephaestus's conversational AI mentor.
25
25
26
26
<divalign="center">
27
27
<picture>
@@ -34,7 +34,7 @@ Hephaestus gives developers feedback on the engineering practices they use in so
34
34
<p><sub>One example of practice feedback and a follow-up with Heph.</sub></p>
35
35
</div>
36
36
37
-
Hephaestus is built for software engineering courses, open-source projects, and teams where mentors and maintainers cannot review every contribution themselves.
37
+
Hephaestus is built for software engineering courses, open-source projects, and teams that want more consistent opportunities to learn from day-to-day contributions.
38
38
39
39
## What Hephaestus does
40
40
@@ -58,12 +58,16 @@ The loop starts with a developer's project work and the context around it. Hepha
58
58
<imgalt="Hephaestus feedback loop: project work and context are reviewed against workspace practices; practice feedback explains what worked, what could improve, and what to try next; it can appear alongside the work or in conversation with Heph; the developer decides whether to use, question, or skip it before their next piece of project work."src="./docs/images/readme/feedback-loop-light.png"width="1224">
59
59
</picture>
60
60
61
-
Developers decide what helps: use the feedback, question it, or skip it. The cycle continues with their next piece of project work. Hephaestus supports mentors, teachers, and maintainers by covering routine feedback. It does not replace their judgement or the relationships they build with developers.
61
+
Developers decide how to use the feedback and can discuss it with Heph. The cycle continues with their next piece of project work. Hephaestus extends the attention available from mentors and maintainers while developers retain responsibility for their decisions.
62
+
63
+
## Project origins
64
+
65
+
Hephaestus is an [MIT-licensed](./LICENSE) open-source project developed by [Applied Education Technologies](https://aet.cit.tum.de/) at the [Technical University of Munich](https://www.tum.de/en/).
62
66
63
67
## Project status
64
68
65
69
> [!IMPORTANT]
66
-
> **Hephaestus is still pre-1.0.** Until 1.0, a minor release can change configuration or APIs in ways that require action. If you self-host it, use the [latest release](https://github.com/ls1intum/Hephaestus/releases/latest), read its release notes and the [migration guide](./MIGRATION.md), and test upgrades in staging.
70
+
> If you self-host Hephaestus, use the [latest release](https://github.com/ls1intum/Hephaestus/releases/latest), read its release notes and the [migration guide](./MIGRATION.md), and test upgrades in staging.
67
71
>
68
72
> We are aiming for a stable **v1.0.0 in mid-September 2026**. Here, stable means [predictable rules](./docs/admin/compatibility-policy.mdx) for upgrades, configuration, Docker Compose, and the REST API — not that development stops.
0 commit comments