Add additional checks and enforcement around Deprecation to the build system. [LUCENE-5719]
- Dominant language
- Java
- Stars
- 3.6k
- Forks
- 1.4k
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 88
Description
It would be great if we enforced a reasonable minimum for deprecation use.
Something like:
- Both the annotation and the comment should be required.
- Comment deprecation should require a comment.
- Annotation should require a JIRA url. (Doesn't seem we could do this nicely :( )
I run into, and perhaps even write, too many places with Deprecate and no helpful path or clue for the user and obviously Deprecation should be as non confusing as possible and polite deprecation enforced to the degree that we can do it.
---
Migrated from [LUCENE-5719](https://issues.apache.org/jira/browse/LUCENE-5719) by Mark Miller (@markrmiller)
Contributor guide
Research direction
The issue names no files, tests, or build entry points. Start by locating Lucene's existing deprecation checks and enforcement in the build system, then determine which of the proposed requirements are feasible. Done means the agreed deprecation rules are enforced and covered by appropriate build tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- build-system
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100