fsprojects / fsprojects/Paket

Integration with ApiComparer

Open
#1,012 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement up-for-grabs
Dominant language
F#
Stars
2.1k
Forks
528
Avg merge
1d 12m
Merged PRs (30d)
54

Description

Crazy idea :)

We're contemplating an api for ApiComparer. Does paket have any integration points where it would make sense to list api changes, warn about breaking changes etc?

paket outdated with a potential --show-diffs looks interesting. I guess it could be just a generated link eg. http://apicomparer.particular.net/compare/rabbitmq.client/3.4.3...3.5.0 or some deeper integration where semver compliance is checked and updates with breaking changes are flagged in the output of the command in some way.

Thoughts?

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 reading the ApiComparer proposal linked in the issue and inspect Paket's existing paket outdated entry point for available integration points. The issue does not define a chosen integration, command behavior, or acceptance criteria, so a concrete design decision is needed before implementation can be considered done.

Written by the indexing model from the issue text.

Assessment

Tech stack
fsharp
Domain
cli, tooling
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.