zalando/zally

Add hint to add compression on all API endpoints

Open

#1,497 opened on May 14, 2024

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Kotlin (156 forks)auto 404
area: rulesgood first issuehelp wanted

Repository metrics

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

Description

It would be very helpful for API designers and implementers to be reminded to enable the compression on their endpoints. Zally can remind API designers to do this and thereby improve our best practices. The hint should point to Rule #156.

Contributor guide

Research direction
Study existing Zally rules and add a new rule that issues a hint for compression, referencing Rule #156.
Tech stack
kotlin
Domain
backendapi
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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.
Clear
Prerequisites
GitKotlin
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80