How to be involved in Tarantool¶
What is Tarantool?¶
Tarantool is an open source database that can store everything in RAM. Use Tarantool as a cache with the ability to save data to disk. Tarantool serves up to a million requests per second, secondary index searches, and SQL support.
In Tarantool, you can execute code alongside data. This allows for faster operations. Implement any business logic in Lua. Get rid of stale entries, sync with other data sources, implement an HTTP service.
Go to Getting Started and try Tarantool.
How to get help?¶
We have a special Telegram chat for contributors. We speak Russian and English in the chat.
This is the easiest way to get your questions answered. Many people are afraid to ask questions because they think they are “wasting the experts’ time,” but no one really thinks so. Contributors are important to us.
Also we have a Stackoverflow tag.
Join the chat and ask questions.
How to leave feedback, idea or suggestion?¶
You can leave your feedback or share ideas in different ways:
- The simplest way is to write here. All you need to do is fill in one product comment field and send it to us. If you don’t mind – leave your email address. If you wish, we can involve you in the product development process.
- A more technical way is to create a ticket on Github.
If you have a suggestion for a new feature or information about a bug,
follow the link
and leave a ticket.
The link leads to the
tarantool/tarantoolrepository. For any other projects on Github select “Issues” - “New issue”.
You can chat with the team in the general product chat. They are divided by language:
If this communication channel is inconvenient for you or there is simply no Telegram, you can leave your comment on tarantool.io. Fill out the form at the bottom of the site and leave your email. We read each request and respond to them usually within 2 days.
How to contribute?¶
There are many ways to contribute to Tarantool:
- Code – Contribute to the code. We have components written in C, Lua, Python, Go, and other languages.
- Write – Improve documentation, write blogposts, create tutorials or solution pages.
- Q&A – Share your acknowledgments at Stackoverflow with tag #tarantool.
- Spread the word – Share your accomplishments in social media using the
#tarantoolhashtags (or CC
Tarantool has a large ecosystem of tools around the product itself.
We divide the Tarantool ecosystem into 4 types:
- Tarantool itself.
- Modules for Tarantool. They can be written in C and Lua.
- Connectors for programming languages.
- Applied tools. For example, Kubernetes operator, Ansible role for deployment,
tarantool-adminutility for viewing data in Tarantool via GUI.
First-time tasks can be easily found in the issues section of any repository by the “good first issue” tag. These are beginner to intermediate tasks that will help you get comfortable with the tool.
See the list of tasks
For each repository we have a queue for reviewing, and reviewing your changes can be delayed. We try to give the first answer within two days. Depending on the ticket and its complexity, the review time may take a week or more.
Please do not hesitate to tag the maintainer in your Github ticket.
Read further about the contribution to each of the blocks.
You have a problem in documentation. How to tell about it and how to fix it?¶
There are several ways to improve the documentation:
- The easiest one is to leave your comment on the web documentation page. All you need to do is click on the red button in the bottom right corner of the page and fill in the comment field. You can point out an error, provide feedback on the current article, or suggest changes. We review each comment and take it to work. This form is built into the documentation on the Tarantool website.
- Advanced – All Tarantool documentation tasks are in the repository. Here you can take any tasks and suggest your changes. Our documentation is written in the ReST format. Here is our Style Guide for writers. After making the change, you need to build the documentation locally and see how it was laid out. This is done automatically in Docker. Read more in the README of the tarantool/doc repository.
Some projects have their documentation in the code repository. For example, Tarantool Cartridge. This is done on purpose, so the developers themselves can update it faster. Instructions for building such documentation sets are in the code repository.
If you find that the documentation in the README of a module or, for example, a connector is incomplete or wrong, the best way to influence this is to fix it yourself. Clone the repository, fix the bug, and suggest changes as a PR. It will take you 5 minutes and will help the whole community.
If for some reason you cannot fix it, create a ticket in this repository and report the error. Such errors are fixed quickly.
How to contribute to modules¶
Tarantool is a database with an embedded application server. You can write any code in C and Lua and pack it in distributable modules.
Here are examples of official modules:
- HTTP server – HTTP server implementation with middleware support.
- queue - Tarantool implementation of a persistent message queue.
- metrics - ready-to-use solution for collecting metrics.
- cartridge - framework for writing distributed applications.
Modules are distributed through our package manager, which is already preinstalled with Tarantool.
We have official modules and unofficial ones. The official ones are those that are in our organization on Github. But we distribute unofficial ones via our package manager too so that other users can get your module easily. If you want to add your module to our Github organization – text us here.
Want to contribute to an existing module¶
Tasks for contributors can be easily found in the issues section of any repository by the “good first issue” tag. These are tasks of an initial or intermediate level of difficulty that will help you get comfortable in the module of interest.
Look at the currently open tasks for the HTTP Server module.
The style guide for the Lua code we are following is here.
You can contact the current maintainer through MAINTAINERS, which is located in the root of the repository. If there is not such a file – let us know. We will respond within one to two days.
If you see that the project does not have a maintainer or is inactive, you can become one yourself. See the section How to become a maintainer.
How to contribute to Tarantool Core¶
Tarantool is written mostly in C. Some parts are written in C++ and Lua. Review can take longer because we want it to be reliable.
- learn how to build Tarantool
- run the test suite
- read about Tarantool architecture and main modules (here and here)
We have standards that we try to adhere to when developing in Tarantool. These are Style Guide and Contribution Guide links. They tell you how to format your code, how to format your commits, and how to write your test and make sure you don’t break anything.
They will also help you make a patch that is easier to check, which will allow you to quickly push changes to master.
Before your first commit, read this article!
A patch can be offered in two ways:
How to write a test¶
The database is the product that is expected to be as reliable as possible.
We at Tarantool have developed a dedicated test framework for developing
test scripts that test Tarantool itself. The framework is called
Writing your own test is not difficult. See test examples here:
We also have a CI that automatically checks build and test coverage for new changes on all supported operating systems. This happens after any commit to the repository.
The QA team has many tasks for specialists who are involved in checking the quality of the product and tools. They provide test coverage for products, help develop the test framework, and introduce and maintain new tools to test the stability of releases.
We test modules differently: for modules, we use the luatest framework. This is a fork of the popular framework in the Lua community, which we have enhanced and optimized for our tasks. See examples. of writing tests for a module.
Read: writing tests in Tarantool, writing unit tests. ???
How to contribute to language connectors¶
A connector is a library that provides an API for accessing Tarantool from a programming language. Tarantool uses its own binary protocol for access, and the connector’s task is to transfer user requests to the database and application server in the required format.
Data access connectors have already been implemented for all major languages. If you want to write your own connector, you first need to familiarize yourself with the Tarantool binary protocol. Its current description can be found here.
We consider the following connectors as reference:
You can look at them to understand how to do it right.
The Tarantool ecosystem has connectors that are supported by the Tarantool team itself, and there are those that are developed and supported exclusively by the community. All of them have their pros and cons. See a complete list of connectors and their recommended versions.
If you are using an existing connector from the community and want to implement new features or fix a bug, then send your PRs via Github to the desired repository.
To contact the author of the connector in case of questions, look in the MAINTAINERS file: there will be contacts of the repository maintainer. If there is no such file – text us here. We will help you figure it out. We usually answer within one day.
How to contribute to tools¶
The Tarantool ecosystem has tools that help in operation, deploy applications, or allow working with Kubernetes.
Examples of tools from the Tarantool team:
- ansible-cartridge: Ansible role for deploying an application on Cartridge
- cartridge-cli: CLI utility for creating applications, launching clusters locally on Cartridge and solving operational problems
- tarantool-operator: Kubernetes operator for cluster orchestration
These tools can be installed via standard package managers:
How to become a maintainer¶
Maintainers are people who can merge PRs or commit to master. We expect maintainers to answer questions and tickets in time, and do code reviews.
If you need to get a review but no one responds for a week, take a look at the
Maintainers section of the
README.md in the repository.
Write to the person listed there.
If you have not received an answer in 3-4 days, you can escalate the question
A repository may have no maintainers (the Maintainers list in
README.md is empty),
or existing maintainers may be inactive. Then you can become a maintainer yourself.
We think it’s better if the repository is maintained by a newbie than if the
repository is dead. So don’t be shy: we love maintainers and help them figure it out.
All you need to do is fill out this form. Indicate which repository you want to access, the reason (inactivity, the maintainer is not responding), and how to contact you. We will consider the application in 1 day and either give you the rights or tell you what else needs to be done.