apache / apache/maven-release

Document deprecations

Open
#1,436 4 comments 0 reactions 0 assignees View on GitHub
deprecated documentation
Dominant language
Java
Stars
128
Forks
145
Avg merge
7h 7m
Merged PRs (30d)
3

Description

### New feature, improvement proposal

A number of methods in this project are deprecated without any docs explaining why they're deprecated or how to replace them. e.g. getWorkItem and setWorkItem in ScmProviderRepository

Document or undeprecate these.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by inspecting the deprecated getWorkItem and setWorkItem methods in ScmProviderRepository, then identify the other deprecated methods covered by the issue. For each, determine whether its rationale and replacement can be documented or whether it should be undeprecated; done means the identified deprecations are addressed.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.