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

IBX-7409: Changed Content Type label to content type #58

Merged
merged 3 commits into from
Jan 22, 2024

Conversation

Gengar-i
Copy link
Contributor

@Gengar-i Gengar-i commented Jan 3, 2024

Question Answer
JIRA issue IBX-7409
Type bug
Target Ibexa version v4.6
BC breaks no

Changed Content Type label to Content type

Checklist:

  • Provided PR description.
  • Tested the solution manually.
  • Provided automated test coverage.
  • Checked that target branch is set correctly (main for features, the oldest supported for bugs).
  • Ran PHP CS Fixer for new PHP code (use $ composer fix-cs).
  • Asked for a review (ping for example @ibexa/php-dev for back-end changes and/or @ibexa/javascript-dev for front-end changes).

@Gengar-i Gengar-i requested review from a team, dew326 and tischsoic January 3, 2024 11:11
@konradoboza konradoboza requested a review from a team January 3, 2024 11:13
Copy link
Contributor

@Steveb-p Steveb-p left a comment

Choose a reason for hiding this comment

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

Whenever we refer to Content Type we use this specific notation to clearly indicate that we are talking about a PHP API object. This IMO should not be changed, especially when dealing with tech savvy users.

@konradoboza
Copy link
Contributor

Whenever we refer to Content Type we use this specific notation to clearly indicate that we are talking about a PHP API object. This IMO should not be changed, especially when dealing with tech savvy users.

It isn't. Description is only used to generate GraphQL "Docs" section. This PR doesn't change the way schema properties are accessed if this is something you had in mind.

@Steveb-p
Copy link
Contributor

Steveb-p commented Jan 3, 2024

Whenever we refer to Content Type we use this specific notation to clearly indicate that we are talking about a PHP API object. This IMO should not be changed, especially when dealing with tech savvy users.

It isn't. Description is only used to generate GraphQL "Docs" section. This PR doesn't change the way schema properties are accessed if this is something you had in mind.

Changes include technical documentation (docs you mentioned), PHP comments, exception messages. These are technical and we used Content Type case "variant" specifically. This allows us to differentiate Content Type object (as an PHP API entity) vs. Content type (as a specific type as declared in application).

Personally I am against changes being run as a search & replace across the whole code base. This was not discussed with the backend team, and seems like a frontend change is bleeding over to backend code, where a specific convention was upheld.

@konradoboza
Copy link
Contributor

Isn't naming within the docs adjusted too in general? If so, I wouldn't be blocking this change - I cannot see any scenario where anyone would be confused with such a trivial naming adjustment.

Copy link

sonarqubecloud bot commented Jan 8, 2024

Quality Gate Passed Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@Gengar-i Gengar-i changed the title IBX-7409: Changed Content Type label to Content type IBX-7409: Changed Content Type label to content type Jan 8, 2024
Copy link
Member

@alongosz alongosz left a comment

Choose a reason for hiding this comment

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

A short comment to the above discussion - if this was a change of ContentType into a content type I would've agreed that it was incorrect as referred to an entity. But "Content Type" is not an entity. If it's a part of a description / a end-user message line, it's fine.

For me +1. Again, this is per case basis and subjective opinion.

@alongosz alongosz requested a review from a team January 10, 2024 11:10
@Nattfarinn Nattfarinn merged commit fe45331 into main Jan 22, 2024
10 checks passed
@Nattfarinn Nattfarinn deleted the ibx-7409-changed-content-type-label branch January 22, 2024 13:50
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.

7 participants