Skip to content

Improve code clarity and consistency through minor refinements#2125

Merged
iMichaela merged 2 commits intousnistgov:developfrom
arpitjain099:feature/improve-code-quality
May 27, 2025
Merged

Improve code clarity and consistency through minor refinements#2125
iMichaela merged 2 commits intousnistgov:developfrom
arpitjain099:feature/improve-code-quality

Conversation

@arpitjain099
Copy link
Copy Markdown
Contributor

@arpitjain099 arpitjain099 commented May 25, 2025

Committer Notes

This pull request makes small but meaningful improvements to comments, naming, and documentation to enhance the overall clarity and consistency of the codebase. While these updates do not impact functionality, they align with best practices for maintainable and high-quality code.

Feedback is welcome, and I’m happy to iterate further if needed. Thanks for taking the time to review!

All Submissions:

By submitting a pull request, you are agreeing to provide this contribution under the CC0 1.0 Universal public domain dedication.

(For reviewers: The wiki has guidance on code review and overall issue review for completeness.)

Changes to Core Features:

  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your core changes, as applicable?
  • Have you included examples of how to use your new feature(s)?
  • Have you updated the OSCAL website and readme documentation affected by the changes you made? Changes to the OSCAL website can be made in the OSCAL-Pages and OSCAL_Reference repositories.

@arpitjain099 arpitjain099 requested a review from a team as a code owner May 25, 2025 18:09
@arpitjain099
Copy link
Copy Markdown
Contributor Author

arpitjain099 commented May 25, 2025

Hi @aj-stein-gsa @nikitawootten-nist — apologies for the unsolicited mention. I noticed you're among the recent top contributors to the repo and thought you might be well-positioned to review this PR. I'd really appreciate your feedback if you have a moment. Thank you!

@iMichaela
Copy link
Copy Markdown
Contributor

iMichaela commented May 26, 2025 •
edited
Loading

Hi @aj-stein-gsa @nikitawootten-nist — apologies for the unsolicited mention. I noticed you're among the recent top contributors to the repo and thought you might be well-positioned to review this PR. I'd really appreciate your feedback if you have a moment. Thank you!

Thank you, @arpitjain099 - Thank you for your contributions. Greatly appreciate. The OSCAL team will review the PR as soon as feasible. Please direct your PR against the develop or feature- branch and not main.*

For more information on how to do this, please refer to our contribution guide.

@iMichaela
Copy link
Copy Markdown
Contributor

iMichaela commented May 26, 2025

@arpitjain099 - I briefly reviewed the proposed changes and they are all great. Thank you for catching all those typos.

@arpitjain099
Copy link
Copy Markdown
Contributor Author

arpitjain099 commented May 26, 2025

@arpitjain099 - I briefly reviewed the proposed changes and they are all great. Thank you for catching all those typos.

Thank you for the encouragement @iMichaela

I'll look forward to opening more pull requests in other repositories. Thank you.

@iMichaela
Copy link
Copy Markdown
Contributor

iMichaela commented May 26, 2025

@arpitjain099 - I briefly reviewed the proposed changes and they are all great. Thank you for catching all those typos.

Thank you for the encouragement @iMichaela

I'll look forward to opening more pull requests in other repositories. Thank you.

Thank you! Please do not forget to change the base on this one to the develop branch

@arpitjain099 arpitjain099 changed the base branch from main to develop May 27, 2025 00:40
@arpitjain099
Copy link
Copy Markdown
Contributor Author

arpitjain099 commented May 27, 2025

@arpitjain099 - I briefly reviewed the proposed changes and they are all great. Thank you for catching all those typos.

Thank you for the encouragement @iMichaela
I'll look forward to opening more pull requests in other repositories. Thank you.

Thank you! Please do not forget to change the base on this one to the develop branch

@iMichaela Changed base to develop branch.

@iMichaela
Copy link
Copy Markdown
Contributor

iMichaela commented May 27, 2025

@arpitjain099 - Super! Thank you.

iMichaela
iMichaela approved these changes May 27, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@iMichaela iMichaela left a comment

Choose a reason for hiding this comment

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

All changes look good to me

@iMichaela iMichaela merged commit e854e26 into usnistgov:develop May 27, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@iMichaela iMichaela iMichaela approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@arpitjain099 @iMichaela