Skip to content

Commit 8d7d4fc

Browse files
committed
Document related packages section
1 parent 96ae644 commit 8d7d4fc

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

‎src/internals/014-docs.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,20 @@ Each package readme should be placed into `README.md` and contain the following:
171171
- [ ] Installation. Usually `composer require`.
172172
- [ ] Getting started. One or two common usage examples are demonstrated.
173173
- [ ] Configuration.
174+
- [ ] Related packages, when the package has common drivers, adapters, integrations, or companion packages.
174175
- [ ] Contributing. It should contain a link to guidelines.
175176
- [ ] Running tests.
176177
- [ ] License.
178+
179+
Use the "Related packages" section to help readers discover packages that are commonly used together with the current
180+
package. Include only packages with a practical relationship: drivers, adapters, framework integrations, or packages
181+
that solve the next step in the same workflow.
182+
183+
Example:
184+
185+
```markdown
186+
## Related packages
187+
188+
- [yiisoft/log-target-file](https://github.com/yiisoft/log-target-file) - writes log messages to files.
189+
- [yiisoft/log-target-stream](https://github.com/yiisoft/log-target-stream) - writes log messages to streams.
190+
```

0 commit comments

Comments
 (0)