> Agent-readable docs index: /llms.txt. Download /docs.zip to grep all markdown files locally.

---
title: Contributing
description: Suggest a fix to the API reference, or report anything else that is wrong or missing.
icon: git-pull-request
sidebar_position: 2
---

# Contributing

Public feedback goes through the
[LuaLS-CS2 repository](https://gitlab.com/neverlose/LuaLS-CS2) on GitLab. It
holds the API definitions these pages and your editor's autocomplete are built
from. Maintainers review everything before it reaches the site.

<Tabs defaultTabIndex={0}>
  <Tab title="Merge request" icon="git-pull-request">
    For a fix to an **API Reference** entry: a description, a parameter or
    return note, an event, or an example.

    <Steps>
      <Step title="Open the entry's source" icon="pencil">
        Use the **Edit** link on the entry. It opens the definition file at that
        line in GitLab's editor.
      </Step>

      <Step title="Make the change" icon="file-pen">
        GitLab offers to fork the repository if you can't edit it directly.
        Change only the text near the entry.
      </Step>

      <Step title="Open a merge request" icon="git-merge">
        Describe what was wrong and submit it against `master`.
      </Step>
    </Steps>
  </Tab>

  <Tab title="Work item" icon="circle-dot">
    For anything else: guides and tutorials, a missing topic, a wrong or
    missing function, navigation or search, or a bug you would rather report
    than fix. You don't need an edit link for it.

    <Steps>
      <Step title="Create a work item" icon="circle-dot">
        Open the repository's [work items](https://gitlab.com/neverlose/LuaLS-CS2/-/work_items)
        and create a new one.
      </Step>

      <Step title="Say where" icon="link">
        Include the page URL and the section.
      </Step>

      <Step title="Say what you expected" icon="message-square-text">
        Describe what is wrong or missing and what you expected instead. For
        code, include a short example.
      </Step>
    </Steps>
  </Tab>
</Tabs>
