Skip to content

[Docs] Add conventions documentation #4718

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

Merged
merged 1 commit into from
Apr 9, 2025

Conversation

Nitemaeric
Copy link
Contributor

@Nitemaeric Nitemaeric commented Nov 27, 2024

Context

We want to align on how the Publish Teacher Training code should be written.

Update: In order to turn this into a collaboratively iterative process, let's start here and add more content in separate PRs.

Changes proposed in this pull request

  • Add some conventions documentation.

Guidance to review

View the documentation here:

@Nitemaeric Nitemaeric self-assigned this Nov 27, 2024
@Nitemaeric Nitemaeric changed the title [WIP] Add conventions documentation [WIP] [Docs] Add conventions documentation Nov 27, 2024
@Nitemaeric Nitemaeric force-pushed the dd/application-architecture-and-conventions branch from dd2d946 to 9717ef7 Compare November 27, 2024 16:07
@Nitemaeric Nitemaeric force-pushed the dd/application-architecture-and-conventions branch 5 times, most recently from 472f038 to 56b2d28 Compare December 18, 2024 14:11
@Nitemaeric Nitemaeric force-pushed the dd/application-architecture-and-conventions branch 2 times, most recently from 6acb1b7 to 36c209e Compare January 28, 2025 12:58
@Nitemaeric Nitemaeric force-pushed the dd/application-architecture-and-conventions branch from 36c209e to 24707cd Compare March 14, 2025 14:23
@Nitemaeric Nitemaeric force-pushed the dd/application-architecture-and-conventions branch from 24707cd to fc8c0be Compare March 27, 2025 15:08
@Nitemaeric Nitemaeric marked this pull request as ready for review March 27, 2025 15:14
@Nitemaeric Nitemaeric requested a review from a team as a code owner March 27, 2025 15:14
@Nitemaeric Nitemaeric changed the title [WIP] [Docs] Add conventions documentation [Docs] Add conventions documentation Apr 2, 2025

def t(key, options = {})
I18n.t(key, options.merge(scope: [:forms, *options[:scope]]))
end
Copy link
Contributor

Choose a reason for hiding this comment

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

If we need to call in the view, is the idea to:

form.object.t('.something')

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No. This is for internally within the object itself. t should be private.

Copy link
Contributor

@tomas-stefano tomas-stefano left a comment

Choose a reason for hiding this comment

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

Minor question: Courses::Query might be in the API in the future so the namespace of Find was not added. So what happens on these edge cases?

The PR looks good to me, 🚀

@Nitemaeric Nitemaeric requested a review from a team April 3, 2025 09:22
@Nitemaeric
Copy link
Contributor Author

Minor question: Courses::Query might be in the API in the future so the namespace of Find was not added. So what happens on these edge cases?

If there is no service namespace, it would be considered shared code :)

@Nitemaeric Nitemaeric force-pushed the dd/application-architecture-and-conventions branch from fc8c0be to b658034 Compare April 9, 2025 10:01
@Nitemaeric Nitemaeric merged commit 5469846 into main Apr 9, 2025
34 checks passed
@Nitemaeric Nitemaeric deleted the dd/application-architecture-and-conventions branch April 9, 2025 10:47
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.

2 participants