Skip to content

Commit 2897ace

Browse files
committed
docs(contributing): point READMEs at example for structure and php-fpm-status for depth
1 parent 3862077 commit 2897ace

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1104,7 +1104,7 @@ If you want to move a service from one Service Set to another, you have to creat
11041104

11051105
### README Structure
11061106

1107-
Each plugin README follows a fixed structure. See [check-plugins/example/README.md](check-plugins/example/README.md) for the reference template. The sections are:
1107+
Each plugin README follows a fixed structure. Use [check-plugins/example/README.md](check-plugins/example/README.md) as the reference template for the structure, and [check-plugins/php-fpm-status/README.md](check-plugins/php-fpm-status/README.md) as the reference for the level of detail and especially for troubleshooting depth that a Linux system engineer expects. When updating or writing READMEs, orient yourself on these two. The sections are:
11081108

11091109
1. **Overview**: Describes *what* the plugin does. A leading sentence stating the main purpose. This must include at least the text from the plugin's `DESCRIPTION` variable. Followed by subsections:
11101110

0 commit comments

Comments
 (0)