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.

Sign up for GitHub

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

Jump to bottom

XS✔ ◾ ✨ New Rule - Do you know the key principles of API Design? #9488

Merged
merged 30 commits into from
Oct 29, 2024
Merged

XS✔ ◾ ✨ New Rule - Do you know the key principles of API Design? #9488

merged 30 commits into from
Oct 29, 2024

Conversation

jeoffreyfischer
Copy link
Member

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

✏️ I saw a great video about key principles of API Design and realised we don't have a rule about it

  1. What was changed?

✏️ I have added a new rule

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

✏️ No

@jeoffreyfischer jeoffreyfischer self-assigned this Oct 25, 2024
@github-actions github-actions bot added the Age: 🥚 - New About 2 hours old label Oct 25, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 25, 2024 •
edited
Loading

PR Metrics

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

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

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

@github-actions github-actions bot changed the title ✨ New Rule - Do you know the key principles of API Design? XS✔ ◾ ✨ New Rule - Do you know the key principles of API Design? Oct 25, 2024
@github-actions github-actions bot added Age: 🐣 - Young About 4 hours old Age: 🐥 - Adolescent About 8 hours old Age: 🐤 - Mature About 16 hours old and removed Age: 🥚 - New About 2 hours old Age: 🐣 - Young About 4 hours old Age: 🐥 - Adolescent About 8 hours old labels Oct 25, 2024
tiagov8
tiagov8 reviewed Oct 25, 2024
View reviewed changes
Copy link
Member

@tiagov8 tiagov8 left a comment

Choose a reason for hiding this comment

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

Hi @jeoffreyfischer

I commited some changes to your new rule, so leaving for someone else to approve ;)

@github-actions github-actions bot added Age: 🐓 - Old About 32 hours old Age: 🍗 - Ancient About 64 hours old 🔥 Merge Debt This PR contains merge debt, see https://www.ssw.com.au/rules/merge-debt/ and removed Age: 🐤 - Mature About 16 hours old Age: 🐓 - Old About 32 hours old labels Oct 26, 2024
@github-actions GitHub Actions
Copy link
Contributor

Howzit @jeoffreyfischer,

This PR has been here a while.

Did you know you should avoid merge debt?

  1. Please action (e.g. get a review) and merge or close

Thanks!

@github-actions github-actions bot added Age: 🦖 - Extinct About 128 hours old and removed Age: 🍗 - Ancient About 64 hours old labels Oct 28, 2024
@github-actions GitHub Actions
Copy link
Contributor

Hi @jeoffreyfischer,

We found some markdown suggestions for your Pull Request:

File Error Rule
rules/key-principles-of-rest-api-design/rule.md Line 67 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: should be surrounded by blank lines Rule MD032

Please review and update your Markdown files accordingly.

1 similar comment
@github-actions GitHub Actions
Copy link
Contributor

Hi @jeoffreyfischer,

We found some markdown suggestions for your Pull Request:

File Error Rule
rules/key-principles-of-rest-api-design/rule.md Line 67 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: should be surrounded by blank lines Rule MD032

Please review and update your Markdown files accordingly.

@danielmackay danielmackay self-requested a review October 29, 2024 22:14
danielmackay
danielmackay requested changes Oct 29, 2024
View reviewed changes
Copy link
Member

@danielmackay danielmackay left a comment

Choose a reason for hiding this comment

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

1 comment not addressed. 2 more minor changes suggested.

rules/key-principles-of-rest-api-design/rule.md Outdated Show resolved Hide resolved
rules/key-principles-of-rest-api-design/rule.md Outdated Show resolved Hide resolved
@github-actions GitHub Actions
Copy link
Contributor

Hi @jeoffreyfischer,

We found some markdown suggestions for your Pull Request:

File Error Rule
rules/key-principles-of-rest-api-design/rule.md Line 52 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: should be surrounded by blank lines Rule MD032

Please review and update your Markdown files accordingly.

lukecookssw
lukecookssw requested changes Oct 29, 2024
View reviewed changes
Copy link
Member

@lukecookssw lukecookssw left a comment

Choose a reason for hiding this comment

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

one comment, but aside from that it looks good

rules/key-principles-of-rest-api-design/rule.md Outdated Show resolved Hide resolved
danielmackay
danielmackay approved these changes Oct 29, 2024
View reviewed changes
Copy link
Member

@danielmackay danielmackay left a comment

Choose a reason for hiding this comment

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

LGTM

@jeoffreyfischer jeoffreyfischer requested review from lukecookssw and removed request for bradystroud October 29, 2024 22:45
lukecookssw
lukecookssw approved these changes Oct 29, 2024
View reviewed changes
Copy link
Member

@lukecookssw lukecookssw left a comment

Choose a reason for hiding this comment

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

🚀

@jeoffreyfischer jeoffreyfischer merged commit c067619 into main Oct 29, 2024
5 checks passed
@jeoffreyfischer jeoffreyfischer deleted the new-rule-key-principles-of-api-design branch October 29, 2024 22:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lukecookssw lukecookssw lukecookssw approved these changes

@bradystroud bradystroud bradystroud approved these changes

@tiagov8 tiagov8 tiagov8 approved these changes

@danielmackay danielmackay danielmackay approved these changes

Assignees

@jeoffreyfischer jeoffreyfischer

Labels
Age: 🦖 - Extinct About 128 hours old 🔥 Merge Debt This PR contains merge debt, see https://www.ssw.com.au/rules/merge-debt/
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@jeoffreyfischer @danielmackay @tiagov8 @bradystroud @lukecookssw