openpatch / openpatch/bitflow

[Task] Class Diagram

Open
#83 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
TypeScript
Stars
44
Forks
4
Avg merge
7m
Merged PRs (30d)
2

Description

Class diagrams have to be created in many computer science courses, therefore we should also have this task format. I think, that we could use React Flow for handling the interactive creating of classes and connections. For adding fields and methods and updating the class name, we could go different ways. Two which come to my mind are:

Update the nodes in place like on the front page of the documentation of React Flow.

Update the nodes by using a sidebar, like we do for the Flow Editor.

My preference is the sidebar approach. Since this enables us to have rich inputs, but not clutter the class diagram.

I am not sure how to evaluate a given class diagram or how to show a statistic, which are core features of Bitflow. If you have any suggestions, feel free to write a comment.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing Flow Editor and the linked React Flow documentation, especially its interactive node editing. Clarify whether class nodes use in-place editing or a sidebar, then define how evaluation and statistics should work. Done means the class-diagram task format has an agreed interaction and assessment scope.

Written by the indexing model from the issue text.

Assessment

Tech stack
react, typescript
Domain
frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.