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 Hephaestus connects practice feedback and conversations with Heph to project work, and adds institutional attribution to the public pages.
Copy file name to clipboardExpand all lines: README.md
+25-45Lines changed: 25 additions & 45 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,65 +21,49 @@
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 reviews how developers plan, explain, and deliver changes in GitHub or GitLab. Each suggestion links back to the work and shows what to address next. Ask Heph why it matters or add context the review did not have.
25
25
26
26
<divalign="center">
27
27
<picture>
28
-
<source media="(max-width: 520px) and (prefers-color-scheme: dark)" srcset="./docs/images/readme/landing-feedback-preview-mobile-dark.png">
29
-
<source media="(max-width: 520px) and (prefers-color-scheme: light)" srcset="./docs/images/readme/landing-feedback-preview-mobile-light.png">
<img alt="Example practice feedback on a focused change: Hephaestus notes that the change is easy to review and suggests explaining why it matters; the developer asks what to write, and Heph suggests a concise sentence." src="./docs/images/readme/landing-feedback-preview-light.png" width="744">
<img alt="A bulk-archive change shown with an unanswered product decision, review feedback, and a question from Heph." src="./docs/images/readme/landing-hero-light.png" width="1224">
33
31
</picture>
34
-
<p><sub>One example of practice feedback and a follow-up with Heph.</sub></p>
35
32
</div>
36
33
37
-
Hephaestus is built for software engineering courses, open-source projects, and teams where mentors and maintainers cannot review every contribution themselves.
34
+
It is built for software engineering courses, open-source projects, and engineering teams that want feedback to stay close to the work that prompted it.
38
35
39
36
## What Hephaestus does
40
37
41
-
-**Practice feedback.** Hephaestus uses AI to review pull requests, merge requests, and issues against the engineering practices configured for a workspace. It can post the feedback as comments on the work.
42
-
-**Heph, the AI mentor.** Developers can talk with Heph about feedback and recent issues, commits, reviews, and pull or merge requests. Heph is available in the web app and, when connected, in Slack.
43
-
-**Project context.** Workspace admins can let Hephaestus use messages from selected, visibly monitored Slack channels and documents from selected Outline collections. Outline is a source of context; Hephaestus does not write to it.
44
-
-**Workspaces.** Each workspace connects its own repositories, chooses its practice catalog, connects an AI model through any OpenAI-compatible endpoint, sets a monthly spending cap, and manages its members and teams.
45
-
-**Optional recognition.** Workspace admins can enable achievements, leagues, a weekly leaderboard, and Slack digests of review activity.
38
+
-**Connects feedback to the work.** Hephaestus reviews pull requests, merge requests, and issues against the practices configured for a workspace and points back to relevant evidence.
39
+
-**Continues the conversation with Heph.** Developers can ask why a suggestion matters or explain context the review missed in the web app or Slack.
40
+
-**Uses connected project context.** GitHub, GitLab, Slack, and Outline integrations provide repository activity, team conversations, and documentation.
41
+
-**Keeps workspaces in control.** Admins configure repositories, practices, AI models, budgets, members, and integrations.
46
42
47
43
## How feedback works
48
44
49
-
The loop starts with a developer's project work and the context around it. Hephaestus reviews the work against the engineering practices configured for the workspace, turns what it finds into feedback, and delivers that feedback where it can help.
45
+
1. A workspace connects its GitHub or GitLab repositories and chooses the engineering practices it cares about.
46
+
2. Hephaestus reviews relevant pull requests, merge requests, and issues for evidence of those practices.
47
+
3. Hephaestus can deliver feedback alongside the contribution and in the web app, with the evidence behind it.
48
+
4. Developers can ask Heph about the suggestion or explain context the review missed.
50
49
51
-
<picture>
52
-
<sourcemedia="(max-width: 640px) and (prefers-color-scheme: dark)"srcset="./docs/images/readme/feedback-loop-mobile-dark.png">
53
-
<sourcemedia="(max-width: 640px) and (prefers-color-scheme: light)"srcset="./docs/images/readme/feedback-loop-mobile-light.png">
54
-
<sourcemedia="(max-width: 1024px) and (prefers-color-scheme: dark)"srcset="./docs/images/readme/feedback-loop-tablet-dark.png">
55
-
<sourcemedia="(max-width: 1024px) and (prefers-color-scheme: light)"srcset="./docs/images/readme/feedback-loop-tablet-light.png">
<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
-
</picture>
50
+
Developers decide whether the feedback fits their work.
60
51
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.
52
+
## Project origins
62
53
63
-
## Project status
54
+
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/). It is named after the Greek god of blacksmiths and craftspeople.
55
+
56
+
## Before upgrading
64
57
65
58
> [!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.
67
-
>
68
-
> 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.
69
-
>
70
-
> Parts of this model already ship. For v1.0, the goal is to support them together as a stable product:
71
-
>
72
-
> -**Project context:** work in GitHub and GitLab, selected Slack channels, and selected Outline documents.
73
-
> -**Feedback delivery:** alongside work in GitHub or GitLab, in a personal view across projects, and in conversation with Heph in the web app or Slack.
74
-
>
75
-
> Release gates take priority over the date. Follow the [v1.0 milestone](https://github.com/ls1intum/Hephaestus/milestone/5) and [release plan](https://github.com/ls1intum/Hephaestus/issues/1377) for current scope and progress.
59
+
> Before upgrading a self-hosted deployment, read the [release notes](https://github.com/ls1intum/Hephaestus/releases/latest), [compatibility policy](./docs/admin/compatibility-policy.mdx), and [migration guide](./MIGRATION.md), then test the upgrade in staging.
76
60
77
61
## Get started
78
62
79
-
-**TUM deployment:**[open the web app](https://hephaestus.aet.cit.tum.de).
80
-
-**Documentation:** read the [user, administrator, and contributor guides](https://ls1intum.github.io/Hephaestus/).
81
-
-**Self-hosting:** follow the [install guide](https://ls1intum.github.io/Hephaestus/admin/install)([INSTALL.md](INSTALL.md)) for the supported Docker Compose path.
82
-
-**Development:** use the [local development guide](https://ls1intum.github.io/Hephaestus/contributor/local-development), and explore the web interface in [Storybook](https://main--66a8981a27ced8fef3190d41.chromatic.com/).
63
+
-**Open the hosted app:**visit the [TUM deployment](https://hephaestus.aet.cit.tum.de).
64
+
-**Learn how it works:** read the [user guide](https://ls1intum.github.io/Hephaestus/user/overview).
65
+
-**Run your own deployment:** follow the [self-hosting guide](https://ls1intum.github.io/Hephaestus/admin/install)or start with [INSTALL.md](INSTALL.md).
66
+
-**Contribute:** use the [local development guide](https://ls1intum.github.io/Hephaestus/contributor/local-development) and explore the interface in [Storybook](https://main--66a8981a27ced8fef3190d41.chromatic.com/).
83
67
84
68
## Get help
85
69
@@ -89,8 +73,4 @@ Developers decide what helps: use the feedback, question it, or skip it. The cyc
89
73
90
74
## Contributing
91
75
92
-
Contributions are welcome. Before you start, read [CONTRIBUTING.md](./CONTRIBUTING.md) and the [Code of Conduct](./CODE_OF_CONDUCT.md). They cover the development workflow, pull request requirements, community expectations, and the project's identity requirements for contributors.
93
-
94
-
The project follows a pull request contribution model and GitHub's [Acceptable Use Policies](https://docs.github.com/en/site-policy/acceptable-use-policies).
95
-
96
-
The project is named after Hephaestus, the Greek god of blacksmiths and craftsmen.
76
+
Contributions are welcome. [CONTRIBUTING.md](./CONTRIBUTING.md) explains how to set up the project, propose a change, run the quality checks, and open a pull request. Participation in the project is governed by the [Code of Conduct](./CODE_OF_CONDUCT.md).
0 commit comments