Skip to content

Commit acee798

Browse files
pgulutzanartembo
authored andcommitted
Fixes gh-1684 Refer to awesome-tarantool and perhaps gh-1654 as well
1 parent 849efc7 commit acee798

File tree

1 file changed

+25
-19
lines changed

1 file changed

+25
-19
lines changed

doc/contributing/contributing.rst

Lines changed: 25 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,12 @@ Many people are afraid to ask questions because they think they are
3434
Contributors are important to us.
3535

3636
Also we have a
37-
`Stackoverflow tag <https://stackoverflow.com/questions/tagged/tarantool>`_.
37+
`Stack Overflow tag <https://stackoverflow.com/questions/tagged/tarantool>`_.
3838

3939
Join the chat and ask questions.
4040

4141
--------------------------------------------------------------------------------
42-
How to leave feedback, idea or suggestion?
42+
How to leave feedback, ideas or suggestions?
4343
--------------------------------------------------------------------------------
4444

4545
You can leave your feedback or share ideas in different ways:
@@ -49,12 +49,12 @@ You can leave your feedback or share ideas in different ways:
4949
All you need to do is fill in one product comment field and send it to us.
5050
If you don't mind -- leave your email address.
5151
If you wish, we can involve you in the product development process.
52-
* **A more technical way** is to create a ticket on Github.
52+
* **A more technical way** is to create a ticket on GitHub.
5353
If you have a suggestion for a new feature or information about a bug,
5454
`follow the link <https://github.com/tarantool/tarantool/issues/new>`_
5555
and leave a ticket.
5656
The link leads to the ``tarantool/tarantool`` repository.
57-
For any other projects on Github select "Issues" - "New issue".
57+
For any other projects on GitHub select "Issues" - "New issue".
5858

5959
See `an example of a feature request <https://github.com/tarantool/tarantool/issues/5046>`_.
6060

@@ -77,8 +77,8 @@ There are many ways to contribute to Tarantool:
7777

7878
* Code -- Contribute to the code.
7979
We have components written in C, Lua, Python, Go, and other languages.
80-
* Write -- Improve documentation, write blogposts, create tutorials or solution pages.
81-
* Q&A -- Share your acknowledgments at Stackoverflow with tag
80+
* Write -- Improve documentation, write blog posts, create tutorials or solution pages.
81+
* Q&A -- Share your acknowledgments at Stack Overflow with tag
8282
`#tarantool <https://stackoverflow.com/questions/tagged/tarantool>`_.
8383
* Spread the word -- Share your accomplishments in social media using the
8484
``#tarantool`` hashtags (or CC ``@tarantooldb`` in Twitter).
@@ -94,8 +94,8 @@ We divide the Tarantool ecosystem into 4 types:
9494
* Tarantool itself.
9595
* Modules for Tarantool. They can be written in C and Lua.
9696
* Connectors for programming languages.
97-
* Applied tools. For example, Kubernetes operator, Ansible role for deployment,
98-
or ``tarantool-admin`` utility for viewing data in Tarantool via GUI.
97+
* Applied tools. See a selection including external tools in the
98+
`"awesome Tarantool" list <https://github.com/tarantool/awesome-tarantool>`_.
9999

100100
First-time tasks can be easily found in the issues section of any repository by
101101
the "good first issue" tag. These are beginner to intermediate tasks that will
@@ -109,7 +109,7 @@ and reviewing your changes can be delayed.
109109
We try to give the first answer within two days.
110110
Depending on the ticket and its complexity, the review time may take a week or more.
111111

112-
Please do not hesitate to tag the maintainer in your Github ticket.
112+
Please do not hesitate to tag the maintainer in your GitHub ticket.
113113

114114
Read further about the contribution to each of the blocks.
115115

@@ -141,7 +141,7 @@ Instructions for building such documentation sets are in the code repository.
141141

142142
If you find that the documentation in the README of a module or, for example,
143143
a connector is incomplete or wrong, the best way to influence this is to fix it
144-
yourself. Clone the repository, fix the bug, and suggest changes as a PR.
144+
yourself. Clone the repository, fix the bug, and suggest changes as a PR (pull request).
145145
It will take you 5 minutes and will help the whole community.
146146

147147
If for some reason you cannot fix it, create a ticket in this repository
@@ -169,10 +169,10 @@ Modules are distributed through our package manager, which is already
169169
preinstalled with Tarantool.
170170

171171
We have official modules and unofficial ones.
172-
The official ones are those that are in our organization on Github.
172+
The official ones are those that are in our organization on GitHub.
173173
But we distribute unofficial ones via our package manager too so that other
174174
users can get your module easily.
175-
If you want to add your module to our Github organization --
175+
If you want to add your module to our GitHub organization --
176176
`text us here <https://t.me/arturbrsg>`_.
177177

178178
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -204,7 +204,7 @@ Want to create a new module
204204

205205
You can also create any custom modules and share them with the community.
206206
`Look at the module template <https://github.com/tarantool/modulekit>`_
207-
and write your own one.
207+
and write your own.
208208

209209
--------------------------------------------------------------------------------
210210
How to contribute to Tarantool Core
@@ -223,7 +223,7 @@ To start:
223223
`here <https://github.com/tarantool/tarantool/wiki/Developer-information>`_)
224224

225225
We have standards that we try to adhere to when developing in Tarantool.
226-
These are Style Guide and Contribution Guide :ref:`links <developer_guidelines>`.
226+
These are the Style Guide and Contribution Guide :ref:`links <developer_guidelines>`.
227227
They tell you how to format your code, how to format your commits, and how to
228228
write your test and make sure you don't break anything.
229229

@@ -235,7 +235,7 @@ Before your first commit, read
235235

236236
A patch can be offered in two ways:
237237

238-
* (preferred) Using a fork and pull mechanism on Github: make changes to your
238+
* (preferred) Using a fork and pull mechanism on GitHub: make changes to your
239239
copy of the repository and submit to us for review.
240240
See details `here <https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork>`_.
241241
* Suggest a patch via the mailing list. Our developers are discussing most of
@@ -246,7 +246,7 @@ A patch can be offered in two ways:
246246
How to write a test
247247
--------------------------------------------------------------------------------
248248

249-
The database is the product that is expected to be as reliable as possible.
249+
The database is a product that is expected to be as reliable as possible.
250250
We at Tarantool have developed a dedicated test framework for developing
251251
test scripts that test Tarantool itself. The framework is called ``test-run``.
252252

@@ -285,20 +285,20 @@ application server in the required format.
285285
Data access connectors have already been implemented for all major languages.
286286
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 :ref:`here <box_protocol-iproto_protocol>`.
287287

288-
We consider the following connectors as reference:
288+
We consider the following connectors as references:
289289

290290
* https://github.com/tarantool-php/client
291291
* `net.box <https://github.com/tarantool/tarantool/blob/master/src/box/lua/net_box.lua>`_ — binary protocol client in Tarantool
292292

293293
You can look at them to understand how to do it right.
294294

295295
The Tarantool ecosystem has connectors that are supported by the Tarantool team
296-
itself, and there are those that are developed and supported exclusively by the
296+
itself, and there are connectors that are developed and supported exclusively by the
297297
community. All of them have their pros and cons. See a
298298
`complete list of connectors and their recommended versions <https://www.tarantool.io/en/download/connectors>`_.
299299

300300
If you are using an existing connector from the community and want to implement
301-
new features or fix a bug, then send your PRs via Github to the desired repository.
301+
new features or fix a bug, then send your PRs via GitHub to the desired repository.
302302

303303
To contact the author of the connector in case of questions, look in the
304304
MAINTAINERS file: there will be contacts of the repository maintainer.
@@ -325,6 +325,12 @@ Examples of tools from the Tarantool team:
325325
These tools can be installed via standard package managers:
326326
``ansible galaxy``, ``yum``, ``apt-get``, respectively.
327327

328+
If you have a tool that might go well in our curated
329+
`"awesome Tarantool" list <https://github.com/tarantool/awesome-tarantool>`_
330+
you can read the
331+
`guide for contributors <https://github.com/tarantool/awesome-tarantool/blob/master/CONTRIBUTING.md>`_
332+
there and submit a pull request.
333+
328334
.. _how_to_become_a_maintainer:
329335

330336
--------------------------------------------------------------------------------

0 commit comments

Comments
 (0)