tarantool / tarantool/doc

[dev guide] Built-in modules naming

Open
#3,308 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

dev
Dominant language
CSS
Stars
15
Forks
49
Avg merge
1d 13h
Merged PRs (30d)
3

Description

Related dev. issue(s): N/A

Product: Tarantool dev guides
Since: N/A
Audience/target: tarantool developers or external contributors
Root document: somewhere in developer guidelines (neither Lua style guide, nor C style guide fit ideally here, so don't know where exactly it should be added - somewhere in https://www.tarantool.io/en/doc/latest/contributing/guidelines_index/)
SME: @ Totktonada (let's also ask an agreement from other server development teams)

Details

It would be good to formalize rules about built-in modules naming. We started a discussion here and, it seems, agreed on some rules:

  1. Use internal.foo for a Lua module that is not exposed into the public API.
    • Existing examples: internal.argparse, internal.trigger, internal.print. (Will be more after this PR.)
  2. Use foo.lib for a Lua/C module that is not exposed into the public API and used in the foo module.
    • Existing examples: net.box.lib. (Will be more after this PR.)

Planning checklist

Note: issue templates are in beta. Give your feedback in #1869.

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

Start at the developer guidelines index and review the naming discussion in PR #8173, including the existing internal.argparse, internal.trigger, internal.print, and net.box.lib examples. Confirm the proposed rules with @Totktonada and the server development teams, choose the appropriate developer-guidelines location, and document the agreed naming conventions.

Written by the indexing model from the issue text.

Assessment

Tech stack
c, lua
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.