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

XS✔ ◾ Add comment to IApiMarker example #8114

Merged
merged 4 commits into from Mar 11, 2024
Merged

Conversation

ncn-ssw
Copy link
Member

@ncn-ssw ncn-ssw commented Mar 11, 2024

  1. What triggered this change? (PBI link, Email Subject, conversation + reason, etc)

Directed to make change by @wicksipedia in email "RE: SSW - Induction - Best Practices for Unit Testing".

The purpose of the change is to decrease the likelihood that IApiMarker instances would be mistakenly deleted from code-bases during refactoring.

  1. What was changed?
  • The IApiMarker template example was changed from an image to text that can be copied and pasted
  • Comments were added to the template referring to the SSW Rule to prevent deletion during refactoring

Note that the other code figures were left as images as those figures used graphical elements such as arrows to highlight lines of code in context.

  1. Did you do pair or mob programming (list names)?

No.

@github-actions github-actions bot added the Age: 🥚 - New About 2 hours old label Mar 11, 2024
Copy link
Contributor

PR Metrics

Thanks for keeping your pull request small.
Thanks for adding tests.

Lines
Product Code -
Test Code -
Subtotal -
Ignored Code 11
Total 11

Metrics computed by PR Metrics. Add it to your Azure DevOps and GitHub PRs!

@github-actions github-actions bot changed the title Add comment to IApiMarker example XS✔ ◾ Add comment to IApiMarker example Mar 11, 2024
Copy link
Member

@wicksipedia wicksipedia left a comment

Choose a reason for hiding this comment

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

approved with suggestion

@ncn-ssw ncn-ssw merged commit fabd926 into main Mar 11, 2024
5 checks passed
@ncn-ssw ncn-ssw deleted the ncn-iapimarker-comment branch March 11, 2024 23:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Age: 🥚 - New About 2 hours old
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants