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

Removed requiements, so the work can be started fresh #1438

Merged
merged 2 commits into from
Oct 18, 2023

Conversation

john-science
Copy link
Member

What is the change?

I have removed all references to requirements in ARMI.

Why is the change being made?

The requirements that were in ARMI were only ever my first pass, from one weekend's worth of work.

Going forward, we are looking at doing a real requirements effort in ARMI, and I feel it is best to just wipe the slate clean. Not to worry, git never forgets.

So, this PR is our starting point for that effort.


Checklist

  • This PR has only one purpose or idea.
  • Tests have been added/updated to verify that the new/changed code works.
  • The release notes (location doc/release/0.X.rst) are up-to-date with any important changes.
  • The documentation is still up-to-date in the doc folder.
  • The dependencies are still up-to-date in pyproject.toml.

@john-science john-science added documentation Improvements or additions to documentation cleanup Code/comment cleanup: Low Priority labels Oct 17, 2023
@john-science
Copy link
Member Author

I am wondering... do we need to add something to the PR checklist that gives people some idea what to do if their PR touches a Requirement, Implementation, or Requirement Test?

Maybe we should also have a section in the docs about that?

@john-science
Copy link
Member Author

@bdlafleur Welcome aboard!

Copy link
Member

@opotowsky opotowsky left a comment

Choose a reason for hiding this comment

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

🧹

Copy link
Member

@albeanth albeanth left a comment

Choose a reason for hiding this comment

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

I am wondering... do we need to add something to the PR checklist that gives people some idea what to do if their PR touches a Requirement, Implementation, or Requirement Test?
Maybe we should also have a section in the docs about that?

Yeah this is a good idea. Let's clean out the old, bring in the new, and then decide what to do on this front. Thoughts?

@john-science john-science merged commit 68f2ede into main Oct 18, 2023
23 checks passed
@john-science john-science deleted the restart_requirements branch October 18, 2023 16:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cleanup Code/comment cleanup: Low Priority documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants