[dev guide] Built-in modules naming
Nobody has claimed this yet.
- 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:
- Use
internal.foofor 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.)- Use
foo.libfor a Lua/C module that is not exposed into the public API and used in thefoomodule.
- Existing examples:
net.box.lib. (Will be more after this PR.)
Planning checklist
- Pick product label:
- Pick type label:
- reference,
- getting started,
- user_guide, etc.
- Estimate complexity in storypoints in the title
- Add to Documentation board → Backlog
Note: issue templates are in beta. Give your feedback in #1869.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- 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