zalando/zally

Breaking change detection

Open

#981 opened on Apr 8, 2019

View on GitHubContributor guide
 (6 comments) (1 reaction) (0 assignees)Kotlin (156 forks)auto 404
help wantedtype: enhancement

Repository metrics

Stars
 (945 stars)
PR merge metrics
 (PR metrics pending)

Description

This feature already discussed in an issue: https://github.com/zalando/zally/issues/874. Do you have a set of rules for it? Do you want to do it expandable and configurable? I found Google definitions of breaking changes and non-breaking changes, for me it looks reasonable: https://cloud.google.com/apis/design/compatibility

Contributor guide

Research direction
Review the referenced issue (#874) and Google's compatibility definitions to design a configurable set of rules for breaking change detection in API specifications.
Tech stack
kotlin
Domain
api
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Needs investigation
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50