Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📖 Docs: Remove experimental language around maintainer annotations #4235

Merged
merged 1 commit into from
Jul 11, 2024
Merged

📖 Docs: Remove experimental language around maintainer annotations #4235

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -419,12 +419,11 @@ RESULTS
|---------|------------------------|--------------------------------|--------------------------------|---------------------------------------------------------------------------|
```

##### Showing Maintainers Annotations (Experimental)
##### Showing Maintainers Annotations

To see the maintainers annotations for each check, use the `--show-annotations` option.

For more information on how to configure annotations or what are the available annotations, see [the configuration doc](config/README.md).
**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.

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

##### Using a GitLab Repository

Expand Down
2 changes: 1 addition & 1 deletion config/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Maintainer Annotations

**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.
**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.

## Annotating Your Project

Expand Down
Loading