TYPO3-Documentation / TYPO3-Documentation/TYPO3CMS-Guide-HowToDocument
Prefix files with "_" for files wich must be exclude from controls Reference/ReStructuredText/Code/Codeblocks.html
Open
Nobody has claimed this yet.
- Dominant language
- Makefile
- Stars
- 9
- Forks
- 123
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 23
Description
It should be good to :
- prefix files names
- explain why we need to prefix with "_"
Current behavior
We don't know that we have to prefix with "_" and why
Expected behavior/output
Adding "_" prefix and explain why in TYPO3 documentation process
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
Open Reference/ReStructuredText/Code/Codeblocks.html and review the current guidance for files excluded from controls. Update the documentation to show the “_” filename prefix and explain why it is required; done means the naming rule and its reason are clear to documentation contributors.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100