plotly / plotly/Plotly.NET

[C#] Plotly.NET.CSharp Roadmap

Offen
#379 0 Kommentare 3 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Area: CSharp Area: Meta Area: MissingAbstraction Type: Enhancement
Vorherrschende Sprache
F#
Sterne
860
Forks
99
Ø Merge
22 Min.
Gemergte PRs (30 T.)
1

Beschreibung

This issue tracks the roadmap for the native C# package Plotly.NET.CSharp

Plans on how to design and develop the C# API have been laid out and tracked in #285 and #322.

The general roadmap implementation-wise is the following:

  • 1. C# bindings for the high-level Chart construction API (#296), one binding per chart at first (no overloads)
  • 2. C# GenericChart Extension methods (this covers more or less all styling functions). Once these are finished, the F# extension methods for fluent interface can be removed.
  • 3. C# bindings for Object abstractions (TraceObjects, LayoutObjects, etc.) this might be a bit tricky
    Progress on this side has been made on the 'csharp-object-bindings' branch. In short, all these bindings can be auto-generated by using reflection on the F# objects. Might be worth to look into C# source generators

The way to go for the future is clearly code generation. The F# core API could in theory also created from the plotly.js JSON schema, but has many features that would be hard to automate such as type safety for enums etc.

To prevent having to namually maintain 2 code bases though, we should at least try to auto-generate the C# API based on the F# API, over which we have full control.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit dem Lesen der Roadmap-Einträge und der bisherigen Designdiskussionen in #285 und #322. Untersuche den Branch csharp-object-bindings, insbesondere src/Plotly.NET.Codegen, und bewerte den vorgeschlagenen Ansatz zur Codegenerierung; die Roadmap ist abgeschlossen, wenn die verbleibenden C#-Erweiterungen und Objektbindungen implementiert sind, ohne eine zweite API manuell zu pflegen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
csharp, fsharp
Bereich
tooling
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.