apache / apache/lucene

remove 'Changes to Backwards Compatibility Policy' from lucene/CHANGES.txt [LUCENE-4943]

Open
#6,007 6 comments 0 reactions 0 assignees View on GitHub
legacy-jira-fix-version:4.9 legacy-jira-fix-version:6.0 legacy-jira-priority:Major type:bug
Dominant language
Java
Stars
3.6k
Forks
1.4k
Avg merge
2d 11h
Merged PRs (30d)
88

Description

CHANGES.txt is useful to summarize the changes in a release.

However its expected that a lot of changes will impact the APIs, this currently hurts the quality of CHANGES.txt because it leads to a significant portion of changes (whether they be bugs, features, whatever) being grouped under this one title.

It also leads to descriptions of CHANGES being unnecessarily verbose.

I think it makes CHANGES confusing and overwhelming, and it would be better to have a simpler 'upgrading' section with practical information on what you actually need to do (like Solr's CHANGES.txt).

---
Migrated from [LUCENE-4943](https://issues.apache.org/jira/browse/LUCENE-4943) by Robert Muir (@rmuir), updated May 09 2016

Contributor guide

Open the contributing guide

Research direction

Start with lucene/CHANGES.txt and compare its current structure with Solr's CHANGES.txt. Identify how the “Changes to Backwards Compatibility Policy” material is currently grouped, then determine the practical upgrading information that should replace it. Done means the release notes are simpler and no longer use that heading, but the issue does not specify the exact replacement content.

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
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.