polyfy / polylith

A tool used to develop Polylith based architectures in Clojure.
Eclipse Public License 1.0
502 stars 47 forks source link

Review and Update Naming doc #407

Closed lread closed 7 months ago

lread commented 7 months ago

Add a quote on naming.

Add links to other docs.

Naming is subjective. Change tone from "this is a good way to name" to "consider naming like so".

Reorder advice on multiple interfaces with same name to come after more generic advice on components.

"For tools, we can use the tool name" did not give any naming advice at all, so replaced it with a suggestion.

Edits for clarity.

lread commented 7 months ago

@tengstrand, ready for review and feedback. As always, please read the commit message before reviewing.