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

Document constraint @test syntax #65

Open
6 tasks
aj-stein-gsa opened this issue Jan 3, 2025 · 0 comments
Open
6 tasks

Document constraint @test syntax #65

aj-stein-gsa opened this issue Jan 3, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@aj-stein-gsa
Copy link
Contributor

User Story

There is limited documentation on constraint @targets, but not @test. It would be a useful improvement to add this documentation to the spec.

Goals

  • Document @test
  • Document relationship to @target, comparing and contrasting it
  • Stretch goal: document "context" management with the use of @test and @target in tandem

Dependencies

No response

Acceptance Criteria

  • All website and readme documentation 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.
  • The CI-CD build process runs without any reported errors on the PR. This can be confirmed by reviewing that all checks have passed in the PR.

Revisions

No response

@aj-stein-gsa aj-stein-gsa added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant