Config writing gruidelines
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 20/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- php
- Domain
- documentation
Research direction
No file, test, or entry point is named. Start by locating the project's INI or configuration documentation and confirm the intended scope with maintainers; done means an agreed, concise guideline covering component-owned configuration, defaults, and namespaced variables.
Written by the indexing model from the issue text.
Description
We should keep a nice and small subset of guidelines on wrtting INI files, mainly to be used as a requirement to make a INI a Respected, thought something like this:
- Configuration for a specific ini should be handled by it, the more, the better. Stick with the defaults mentioned by the component, if none we fall back to PHP standards
- Configuration variables (not instance objects) on a ini should have a namespace reflecting the INI filename to prevent conflitcs with other Respecteds
- Dominant language
- PHP
- Stars
- 99
- Forks
- 7
- PR merge metrics
- No merged PRs in 30d
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.
More from Respect/Config
-
bug
Difficulty 3/5 1-2 days Newbie friendliness 30/100
-
100% Code coverage Open
Difficulty 5/5 Over a week Newbie friendliness 15/100
-
Difficulty 5/5 Over a week Newbie friendliness 20/100
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
-
feature
Difficulty 4/5 3-5 days Newbie friendliness 25/100
Similar issues
-
Solved site promotion gate fails on runner PHP patch drift (expects 8.2.33, runner installs 8.2.34) Open
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Automattic/blocks-engine#2161 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
Automattic/static-site-importer#1824 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
0. Needs triage bug
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
0. Needs triage 35-feedback bug
Difficulty 2/5 1-3 hours Newbie friendliness 75/100