opensearch-project / opensearch-project/.github

[Repository Request]New Repository: opensearch-query-grammar

Open
#335 9 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

repository-request
Dominant language
No language data
Stars
41
Forks
74
Avg merge
3d 19h
Merged PRs (30d)
1

Description

Are you requesting a new GitHub Repository within opensearch-project GitHub Organization?

Yes

GitHub Repository Proposal

https://github.com/opensearch-project/.github/issues/333#

GitHub Repository Additional Information
  1. What is the new GitHub repository name?
    opensearch-query-grammar
  2. Project description and community value?
    This repo will serve as a unified grammar package as the single source of truth for sql plugin and opensearch-spark
  3. What user problem are you trying to solve with this new repository?
    The key benefit of a centralized grammar package is that it eliminates the error-prone and inefficient process of manually synchronizing grammar files across multiple components.
  4. Why do we create a new repo at this time?
    This improves consistency, as all downstream systems will consume the same version of the grammar, and enhances maintainability by simplifying the release management process.
  5. Is there any existing projects that is similar to your proposal?
    No
  6. Should this project be in OpenSearch Core/OpenSearch Dashboards Core? If no, why not?
    Or, shall we combine this project to an existing repo source code in opensearch-project GitHub Org?
    No, this project should not be in OpenSearch Core or Dashboards Core.
    It is a shared utility package focused specifically on SQL grammar definitions, designed to be reused across multiple repositories (e.g., SQL plugin and OpenSearch Spark). Keeping it as a standalone repo allows for modular development, independent versioning, and clearer dependency management.
  7. Is this project an OpenSearch/OpenSearch Dashboards plugin to be included as part of the OpenSearch release?
    No, this is not a plugin.
    It is a shared library meant to be consumed by other OpenSearch plugins or projects (such as sql and opensearch-spark). It will not be directly released as part of the OpenSearch distribution itself.
GitHub Repository Owners
  1. Who will be supporting this repo going forward?
    @ahkcs, @noCharger, @penghuo, @dai-chen, @RyanL1997, @anirudha, @Swiddis, @ykmr1224, @anasalkouz
  2. What is your plan (including staffing) to be responsive to the community (at a minimum, this should include reviewing PRs, responding to issues, answering forum questions?)
    This project will be maintained by members of the insights-query-experiences team. We will ensure responsiveness by:

Actively monitoring GitHub issues and PRs in this repository.

Reviewing contributions and providing timely feedback.

Triaging bugs and enhancement requests regularly.

Keeping documentation up-to-date to help contributors and users understand how to use and contribute to the grammar package.

  1. Initial Maintainers List (max 3 users, provide GitHub aliases):
    @ahkcs, @noCharger
GitHub Repository Source Code / License / Libraries
  1. Please provide the URL to the source code.
    The source code is under development and will be added once the repository is created.
  2. What is the license for the source code?
    The source code will be licensed under the Apache License 2.0, consistent with the rest of the OpenSearch project.
  3. Does the source code include any third-party code that is not compliant with the Apache License 2.0?
    No. We do not plan to include any third-party code that is incompatible with the Apache License 2.0.
What is the publication target(s)?

You can choose multiple targets from the list.

No response

Notes (DO NOT CHANGE)

Next Steps:

  • If this is about creating a new GitHub Repository

    • Build Interest Group (BIG) and its members will review your proposal and provide feedback
      • Review of Proposal, asking questions, adding comments
      • If there is any concern regarding the naming / IP, additional IP review will be requested
      • Involve Subject Matter Experts from other repositories on the proposed topics
      • Ensure new repositories align with the foundation’s charter
      • Review the provided source code if any
      • Send final feedback and recommendations to the Technical Steering Committee
    • Technical Steering Committee (TSC) will have a vote based on BIG feedback, and reply back the vote as a comment in this issue by a TSC member
    • At least three positive (+1) TSC members' votes are necessary, and no vetoes (-1) after a one week period, then Admin Team will open a repo creation ticket with Linux Foundation
    • Linux Foundation verify the votes and create repo
    • Admin Team setup automations on repo settings, secrets, scanning, add initial maintainers, and more
    • Repository delivered to the original requester
  • If you already have a GitHub repo and just want to add new publication target(s)

    • Admin Team will review your request and follow up

Track the progress of your request here: https://github.com/orgs/opensearch-project/projects/208/views/33.
Member of @opensearch-project/admin will take a look at the request soon.
Thanks!

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

No source files or tests are named because the source is still under development. Start with the linked proposal and the tracking project, then verify completion by confirming the BIG/TSC review and repository-creation steps are completed.

Written by the indexing model from the issue text.

Assessment

Tech stack
sql
Domain
databases
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.