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

Standardize Non-Functional Requirement Labels. #3965

Merged
merged 3 commits into from
Sep 19, 2024
Merged

Conversation

Xinlu-Y
Copy link
Collaborator

@Xinlu-Y Xinlu-Y commented Sep 19, 2024

Closes #3756

  • Refactored the NFR descriptions into reusable functions to prevent inconsistencies across different examples.
  • Modified the NFR labels in the following examples:
  • dblpend
  • GlassBR
  • SWHSNoPCM
  • PDController
  • Projectile
  • SglPend
  • SSP
  • SWHS

- Modified the following examples: dblpend, GlassBR, SWHSNoPCM, PDController, Projectile, SglPend, SSP, SWHS.
keep the code clean and avoid unnecessary dependencies.
Copy link
Collaborator

@smiths smiths left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The changes to the NFRs are an improvement. The standardization across examples is an improvement. Reviewing the changes highlights that some of the NFRs aren't very good requirements, but that is a separate problem. They weren't good before this change and the change makes them better. There is still room for improvement in the requirements themselves, but that can be a discussion for another day.

I'm fine with the PR, but @JacquesCarette will have to judge the changes to the Haskell code. (I just looked at the changes to stable.)

Copy link
Owner

@JacquesCarette JacquesCarette left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice improvements!

@JacquesCarette JacquesCarette merged commit 6abd87c into main Sep 19, 2024
5 checks passed
@JacquesCarette JacquesCarette deleted the NFRConsistency branch September 19, 2024 19:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Change Non-Functional Requirement (NFR) labels in the SRS to be consistent with the template
3 participants