https://github.com/repcomm/signachurn

signachurn analyses API over releases to rank stability for developers
https://github.com/repcomm/signachurn

Last synced: 10 months ago
JSON representation

signachurn analyses API over releases to rank stability for developers

• Host: GitHub
• URL: https://github.com/repcomm/signachurn
• Owner: RepComm
• Created: 2024-07-11T01:41:24.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-25T13:29:38.000Z (over 1 year ago)
• Last Synced: 2025-03-23T03:15:00.219Z (10 months ago)
• Language: Go
• Homepage:
• Size: 496 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: ReadMe.md

Awesome Lists containing this project

README

          
# signachurn

- analyse API changes over release history

- compare libraries on API stability

- quantify future/past wasted time on 'reworks'

- quantify future affect on ecosystem based on known dependants

## problem

reworking is usually bad for dependants: you retype something, all dependants must adjust their code

## auxiliary

signachurn identifies signature changes over release history

- devs encouraged to pick dependencies that will require less rework

- dependencies encouraged design with the future in mind, adapt method bodies rather than method names/types

## under-the-hood

signachurn is a tool built using golang made of several components

- a database (pocketbase)

  - store signature scan data

  - store known dependants statistics

- a web frontend

  - developer / project manager interface

- a job system

  - keeps up-to-date with libs

- a job scan plugin system

  - for adding language support

![img](./design_front.svg)

![img](./example0.png)