purescript / purescript/pursuit

Tool to show differences between two versions of a package

Open
#139 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Haskell
Stars
174
Forks
47
PR merge metrics
No merged PRs in 30d

Description

In short, copy elm-package diff. For example:

$ elm-package diff evancz/elm-markdown 1.0.0 1.1.0

Comparing evancz/elm-markdown 1.0.0 to 1.1.0...
This is a MINOR change.

------ Changes to module Markdown - MINOR ------

    Added:
        type alias Options =
            { githubFlavored : Maybe { tables : Bool,
                                       breaks : Bool
                                     },
              sanitize : Bool,
              smartypants : Bool
            }
        defaultOptions : Options
        toElementWith : Options -> String -> Element
        toHtmlWith : Options -> String -> Html

Source: http://elm-lang.org/blog/announce/0.14#better-build-tools

I wonder if it might work better for us to implement this inside the Pursuit web app, though.

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

Use the elm-package diff example as the behavioral reference, then review the Pursuit web app's existing package and version-handling entry points. Resolve whether the comparison belongs in the web app or as a separate tool, and consider the work complete when two package versions produce a useful change classification and API difference report.

Written by the indexing model from the issue text.

Assessment

Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.