apache / apache/lucenenet

Create rulesets for dev analyzers

Open
#1,143 1 comment 0 reactions 0 assignees View on GitHub
good-first-issue hacktoberfest is:task up-for-grabs
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

Context: https://github.com/apache/lucenenet-codeanalysis-dev/pull/1#pullrequestreview-2671980160

From @NightOwl888:

> I noticed that Microsoft uses .ruleset files to group rules together. Since we will have specific rules that will need to be enabled when we upgrade to the next version of Lucene (LuceneDev1000-LuceneDev1004 are all good examples of these) it would be good to be able to group them.
>
> 1. Default - for general development
> 2. Upgrade - only useful when upgrading Lucene
> 3. Code Search - only useful when searching for complex code patterns that are specific to Lucene's design that are too difficult to do using Find and Replace
>
> I suspect there will be other categories as the project develops.
>
> According to ChatGPT we can use .ruleset files for this purpose: https://chatgpt.com/share/67cfaeeb-72c4-8005-a530-afb1e27cec94

Contributor guide

Open the contributing guide

Research direction

Start with the linked pull-request review and inspect how the repository currently configures its development analyzers. Define .ruleset files for Default, Upgrade, and Code Search, then verify that LuceneDev1000-LuceneDev1004 are grouped appropriately.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.