Guideline on Contributions

[davibarreira]

Hey, very nice package. I've used a bit, and I'm interested in contributing. I was wondering if there are any guidelines.

Thanks.

[hexaeder]

Hey Davi, thanks for your interest :) We don't really have any contribution guidlines yet but for sure contributions are welcome!

I implemented most of the GraphMakie features based on what I needed for my graph plots at the time. There is no real roadmap or anything yet. But here are some random/unordered thoughts what should happen further down the road:

• in flow networks the flow direction on an edge does not allways correspond to the edge direction in the Graph/DiGraph. It would be nice to have this controllable somehow, i.e. add some kind of parameter to change the arrow direction on a per edge base
• the BezierCurve stuff should move to Makie at some point, but i think this can wait. depends on the future of https://github.com/JuliaPlots/Makie.jl/pull/979
• make it possible to plot edge labels over the edges with a white background color (cc @mroavi), for that we'd need to create some kind of text recipe with background. Or maybe extend the poly recipe to add text to it? (see discourse)
• the whole package is centered around the idea of graphplots beeing small dots connected with lines. More complex examples, i.e. a mindmap with text inside the nodes would be cool to. However this is not realy compatible with how we do layouts currently. Maybe at some point we want to introduce different recipes for different kinds of graph plots? Like they do at GraphRecipes.jl.

besides the features:

• reference tests. this would be great. ideally i'd like to connect those to the doc builds, i.e. test all the examples in the docs. And new testes become also examples in the docs.
• documentation ? you tell me i wrote the docs its hard to tell whether they are extensive enough. I think they are reasonalbe up to date

Also, feel free to contact me on slack. We can talk about the ideas you've got and get your PRs going :)

[davibarreira]

Thanks for the reply! I have some ideas, I'll let you know. I'm trying to dive deeper into Makie, and contributing to this package seems like a nice way of doing so.

[hdavid16]

@hexaeder, Makie now supports BezierPaths (the PR you referenced was merged 4 months ago), should we remove some of the content from beziercurves.jl and use it from Makie.jl?

[hexaeder]

Definitely worth a look but nut sure if there is much we can reuse. Makie uses those to construct low level markers, which is why the path-types are limited to Point2f. We need 3d and a quite distinct set of features (mainly interpolation of splines and tangential vectors) so the overlap is not to big.