Skip to content

Commit 7563971

Browse files
authoredJul 11, 2024··
docs: maintainer annotations (#4235)
Signed-off-by: Raghav Kaul <[email protected]>
1 parent c75c63c commit 7563971

File tree

2 files changed

+4
-5
lines changed

2 files changed

+4
-5
lines changed
 

‎README.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -419,12 +419,11 @@ RESULTS
419419
|---------|------------------------|--------------------------------|--------------------------------|---------------------------------------------------------------------------|
420420
```
421421

422-
##### Showing Maintainers Annotations (Experimental)
422+
##### Showing Maintainers Annotations
423423

424-
To see the maintainers annotations for each check, use the `--show-annotations` option.
425-
426-
For more information on how to configure annotations or what are the available annotations, see [the configuration doc](config/README.md).
424+
**Maintainer Annotations** let maintainers add context to display alongside Scorecard check results. Annotations can provide users additional information when Scorecard has an incomplete assessment of a project's security practices. To see the maintainers annotations for each check, use the `--show-annotations` option.
427425

426+
For more information on available annotations or how to make annotations, see [the configuration doc](config/README.md).
428427

429428
##### Using a GitLab Repository
430429

‎config/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Maintainer Annotations
22

3-
**Maintainer Annotations** are an experimental feature that let maintainers add context to Scorecard check results. Annotations can inform users when Scorecard is incorrectly assessing a project's security practices.
3+
**Maintainer Annotations** let maintainers add context to display alongside Scorecard check results. Annotations can provide users additional information when Scorecard has an incomplete assessment of a project's security practices.
44

55
## Annotating Your Project
66

0 commit comments

Comments
 (0)
Please sign in to comment.