apache / apache/lucenenet

Tool to compare public API surface with Lucene

Open
#1,022 4 comments 0 reactions 1 assignee Claimed by @paulirwin View on GitHub
is:task pri:normal
Dominant language
C#
Stars
2.4k
Forks
658
Avg merge
3d 5h
Merged PRs (30d)
9

Description

### Is there an existing issue for this?

- [X] I have searched the existing issues

### Task description

We should create a tool that compares the public API surface of Lucene (at a specified version) to Lucene.NET. See https://github.com/apache/lucenenet/pull/1018#discussion_r1842137526 for context.

ChatGPT suggested comparing the metadata generated by Docfx and javadoc. Another alternative might be creating a Java tool to export JSON or XML of the public API surface via reflection, and then create a .NET tool that compares that via .NET reflection to Lucene.NET's assemblies.

This will require mapping Java naming conventions to .NET, amongst other challenges. We'd likely need the ability to create a manual mapping/exclusions file to handle discrepancies. But this will help us confirm the public API of Lucene.NET matches Lucene, as well as aid future porting efforts.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.