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

Improve naming conventions in a future major release #2443

Open
2 tasks
Cervator opened this issue Aug 15, 2016 · 0 comments
Open
2 tasks

Improve naming conventions in a future major release #2443

Cervator opened this issue Aug 15, 2016 · 0 comments
Labels
Category: Doc Requests, Issues and Changes targeting javadoc and module documentation Status: Needs Investigation Requires to be debugged or checked for feasibility, etc. Topic: Architecture Requests, Issues and Changes related to software architecture, programming patterns, etc.

Comments

@Cervator
Copy link
Member

Cervator commented Aug 15, 2016

I think we should formalize naming for a few major class types. At present we have some inconsistencies like BeforeDeactivateComponent which is actually an Event and should probably be named BeforeDeactivateComponentEvent

We could probably write Checkstyle rules to help enforce this. The types I have in mind:

  • Systems should end in System
  • Components should end in Component
  • Events should end in Event
  • Maybe something about Actions? They may be too ambiguous at present to narrow down. Are they supposed to be sort of like a System version of a functional interface - they only do one thing? Should they be an allowed exception to the System naming or does that just complicate things?

If there are no objections I think we should move ahead with marking style violations then @deprecate poorly named classes as we come across them, much like fixing style violations in general (if you're working in an area keep an eye out). Offer a better named replacement class, potentially with a new handler method somewhere with the old one just calling the new one, and let modules migrate to the new naming over time. Then delete the outdated version come next major release. Unless the deprecation was too recent.

Candidates:

  • BeforeDeactivateComponent to BeforeDeactivateComponentEvent - widely used across modules
  • OnActivatedComponent to OnActivatedComponentEvent
@Cervator Cervator added Status: Needs Investigation Requires to be debugged or checked for feasibility, etc. Category: Doc Requests, Issues and Changes targeting javadoc and module documentation API labels Aug 15, 2016
@Cervator Cervator added this to the v2.0.0 milestone Aug 15, 2016
@Cervator Cervator mentioned this issue Feb 6, 2017
9 tasks
@Cervator Cervator removed this from the v2.0.0 milestone May 16, 2020
@skaldarnar skaldarnar added Topic: Architecture Requests, Issues and Changes related to software architecture, programming patterns, etc. and removed Api labels May 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Category: Doc Requests, Issues and Changes targeting javadoc and module documentation Status: Needs Investigation Requires to be debugged or checked for feasibility, etc. Topic: Architecture Requests, Issues and Changes related to software architecture, programming patterns, etc.
Projects
None yet
Development

No branches or pull requests

2 participants