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

Clarify that input and output interfaces means APIs. #154

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Clarify that input and output interfaces means APIs. #154

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
74bca2c
Clarify OSPS-SA-02
evankanderson Jan 17, 2025
8400e54
Merge remote-tracking branch 'upstream/main' into clarify-sa-02
evankanderson Jan 21, 2025
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
10 changes: 8 additions & 2 deletions baseline/OSPS-SA.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,16 +35,22 @@ criteria:
maturity_level: 1
criterion: |
The project documentation MUST include
descriptions of all external input and output
descriptions of all external software
interfaces of the released software assets.
rationale: |
Provide users and developers with an
understanding of how to interact with the
project's software and integrate it with
other systems, enabling them to use the
software effectively.
implementation: |
The project README should include a link to
the API documentation, often under a header
such as "Usage", "API Reference", or "Docs".
Documentation badges should also be considered
when recognized (e.g. readthedocs, godoc, etc.).
details: |
Document all input and output interfaces of
Document all software interfaces (APIs) of
the released software assets, explaining how
users can interact with the software and
what data is expected or produced.
Expand Down
Loading