JuliaGeometry / JuliaGeometry/GeometryBasics.jl

Breaking Changes ?

Open
#230 8 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Julia
Stars
215
Forks
64
Avg merge
3d 18h
Merged PRs (30d)
2

Description

The transition from 0.4 to 0.5 indeed appears to be breaking:see e.g.
https://github.com/JuliaGeometry/TetGen.jl/issues/41

So my questions are:

  • What exactly needs to be changed in existing code to allow for 0.5 ?
  • Is is possible to have code which can uses both v4 and v5 ?

Generally it would be good to have some transition guide which also might be a start for an improved documentation as discussed in #222.

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 linked TetGen.jl issue and GeometryBasics.jl issue #222, then compare the relevant 0.4 and 0.5 changes. Document the required updates to existing code and whether one codebase can support both versions; done means the transition guide answers both questions.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.