doc/topics/development/conventions/formulas.rst ID Naming Standard
Open
Nobody has claimed this yet.
Confirmed
doc-rework
documentation
severity-medium
time-estimate-sprint
- Dominant language
- Python
- Stars
- 15.7k
- Forks
- 5.6k
- Avg merge
- 2d 44m
- Merged PRs (30d)
- 80
Description
Description of Issue/Question
doc/topics/development/conventions/formulas.rst needs to talk more about suggested ID Naming Standard for https://github.com/saltstack-formulas e.g if everyone used install_pkg for an ID salt would fail.
It needs to provide guidance on naming the ID. e.g.
- prefix with formula state name
- use suffix with formula state name
etc
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 in doc/topics/development/conventions/formulas.rst and review the existing formula conventions. Add guidance for naming IDs, including formula-state prefixes or suffixes and the install_pkg collision example; the documentation is done when these recommendations are clearly explained for saltstack-formulas users.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100