Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Contributing guide #35

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion src/content/wiki/build.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: Build
description: Instructions for building the Lua Language Server from source.
getting-started: true
carsakiller marked this conversation as resolved.
Show resolved Hide resolved
---

import Tabs from "~/components/common/Tabs.astro";
Expand Down
29 changes: 29 additions & 0 deletions src/content/wiki/contributing.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: Contributing
description: How to contribute to the development of Lua Language Server.
getting-started: true
---

Thank you for showing interest in helping improve the language server!

There are many areas in which you can help. This article gives some starting pointers to help you navigate your way to contributing.

## Developing Lua Language Server

If you have some knowledge of Lua, grab the code and start hacking on whatever you wish. You can consult [Build](/wiki/build) and [Developing](/wiki/developing) articles at your convenience. An overview of the project's file structure is found [here](/wiki/developing#file-structure).

After sending a patch, consider writing a short description of your feature/bugfix consider writing a short entry in the project's [changelog.md](https://github.com/LuaLS/lua-language-server/blob/master/changelog.md) file, so it's visible to users.

## Contributing LuaCATS Annotations

Lua Language Server's system for annotating code is named LuaCATS, Lua Comment And Type System. You can contribute to our ecosystem by writing LuaCATS annotations for widely used Lua libraries. This gives the language server's users out-of-the-box autocomplete suggestions for use with those libraries.

A general reference to LuaCATS is found in the [Annotations](/wiki/annotations) article. The official place for the annotations is the [LuaCATS organization](https://github.com/LuaCATS). Issue reports and patches to official LuaCATS annotations should be sent to the appropriate repository in that organization.

## Contributing Translations

Lua Language Server supports localization. For an overview of this system with a contributing guide see the [Translations](/wiki/translations) article.

## Writing Documentation

A [guide](https://github.com/LuaLS/LuaLS.github.io/blob/main/docs/CONTRIBUTING.md) is available for contributing to this wiki.