cjoudrey/graphql-schema-linter

Add a rule to ensure deprecation reasons have a date and the date hasn't passed.

Open

#4 opened on Aug 3, 2017

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)JavaScript (61 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (704 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

The goal of this rule is:

  • To push API clients off deprecated fields by letting them know when a field will get removed.
  • Encourage API owners to remove deprecated fields once the deprecation date has passed.
  • Possibly warn API owners as the deprecation date approaches (possibly configurable?).

Contributor guide

Research direction
Examine existing linter rules to understand pattern, then implement a rule that checks deprecation reason for a date and validates it.
Tech stack
javascriptgraphql
Domain
backendtooling
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.
1-2 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.
Clear
Prerequisites
GraphQLJavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60