JuliaDiff / JuliaDiff/FiniteDifferences.jl

Roadmap to a v1.0.0

Open
#48 2 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Julia
Stars
318
Forks
32
PR merge metrics
No merged PRs in 30d

Description

This is a lovely little package. So useful!

In recent months it's move into the JuliaDiff org, been renamed for discoverability (by popular demand!), and become the corner stone for testing other JuliaDiff packages (not least ChainRules.jl).

Perhaps it is time to think about a v1.0?

From https://semver.org/

Major version zero (0.y.z) is for initial development. Anything MAY change at any time. The public API SHOULD NOT be considered stable.

Version 1.0.0 defines the public API. The way in which the version number is incremented after this release is dependent on this public API and how it changes.

Roughly speaking, a major release is saying that we are happy enough with the current API to keep supporting it and don't intended to make any breaking changes to it in, say, the next year or so. In return, users can get all new features "for free" without having to keep opting in to each new 0.y release.

  • some open issues are specifically concerning the API, e.g. #35,
  • some feature requests, e.g. #1, #2, are significant enough that they may make us rethink some APIs?
  • others I do not know e.g. #24

Any issues that fit the bill can be tagged with the v1 milestone.

This is an issue so we can discuss these things and make sure we get to v1.

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 discussion and the referenced issues #35, #1, #2, and #24, then inspect the linked v1 milestone. Determine which API or feature questions must be resolved before v1. Done means the scope and compatibility expectations are agreed, relevant issues are identified, and the project has a clear path to the v1 release.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
15/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.