OAI / OAI/tools.openapis.org

Ignore Approach and Implementation

Open
#52 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

data data quality investigation required
Dominant language
JavaScript
Stars
177
Forks
87
Avg merge
1m
Merged PRs (30d)
1

Description

User Story

As a user of tooling-related data I want to ignore anything that appears to be boilerplate code, unmaintained or archived.

As a maintainer of tooling-related data I want to reduce the amount of queries run against projects that appear to be boilerplate code, unmaintained or archived.

Detailed Requirement

Given the "coarse-grained" nature of the data collection approach there is a great deal of opportunity for "dross" to clutter up the tooling dataset. Some examples:

  • Tools removed from sources.
  • Dead repositories with no history or anything particularly interesting about them.
  • Repositories with zero stars that have not changed in eons.
  • Repositories that are tagged but not actually anything to do with OpenAPI.

We therefore need to decide on:

  • The policy for ignoring this stuff.
  • An implementation in the gulp build to sift it out.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the issue's examples of boilerplate, unmaintained, archived, and unrelated repositories, then inspect the gulp build where filtering is requested. Define the policy for ignoring these entries and identify how the collection queries are assembled. Done means the policy is documented and the gulp process sifts out the agreed categories before unnecessary project queries run.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.