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.

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

Update contributing guide for new validations tooling #646

Closed
10 of 21 tasks
aj-stein-gsa opened this issue Aug 30, 2024 · 0 comments · Fixed by #647
Closed
10 of 21 tasks

Update contributing guide for new validations tooling #646

aj-stein-gsa opened this issue Aug 30, 2024 · 0 comments · Fixed by #647
Assignees
Labels
enhancement New feature or request

Comments

@aj-stein-gsa
Copy link
Contributor

aj-stein-gsa commented Aug 30, 2024

This is a ...

improvement - something could be better

This relates to ...

  • the FedRAMP OSCAL Registry
  • the FedRAMP OSCAL baselines
  • the Guide to OSCAL-based FedRAMP Content
  • the Guide to OSCAL-based FedRAMP System Security Plans (SSP)
  • the Guide to OSCAL-based FedRAMP Security Assessment Plans (SAP)
  • the Guide to OSCAL-based FedRAMP Security Assessment Results (SAR)
  • the Guide to OSCAL-based FedRAMP Plan of Action and Milestones (POA&M)
  • the FedRAMP SSP OSCAL Template (JSON or XML Format)
  • the FedRAMP SAP OSCAL Template (JSON or XML Format)
  • the FedRAMP SAR OSCAL Template (JSON or XML Format)
  • the FedRAMP POA&M OSCAL Template (JSON or XML Format)

User Story

As a developer or engineer using, extending, or integrating FedRAMP automation tools into my own work, I would like improved documents about contributing to the newer Metaschema-constraints so I can modify or add them as part of my development work.

Goals

  • Summarize the structure of constraint automation components and how they interact
  • Explain how to add and modify tests to this repo
  • Explain how to add or modify tests in a different code base and integrate them these core tests with contributing upstream

Dependencies

Acceptance Criteria

  • All FedRAMP Documents Related to OSCAL Adoption (https://github.com/GSA/fedramp-automation) affected by the changes in this issue have been updated.
  • A Pull Request (PR) is submitted that fully addresses the goals of this User Story. This issue is referenced in the PR, and it explains:
    • structure of the automation components and interactions of constraints and tests are clear;
    • how to modify a test to contribute to this upstream repo;
    • how to add a new test for new functionality to contribute to this upstream repo; and
    • how to extend tests in a different code base in your own environment to not submit to this repo upstream.

Other information

No response

@aj-stein-gsa aj-stein-gsa added the enhancement New feature or request label Aug 30, 2024
@aj-stein-gsa aj-stein-gsa self-assigned this Aug 30, 2024
@aj-stein-gsa aj-stein-gsa linked a pull request Aug 30, 2024 that will close this issue
7 tasks
@Rene2mt Rene2mt added this to the Digital Authorization Phase 1 milestone Sep 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants