search

artefactual-sdps / enduro

A tool to support ingest and automation in digital preservation workflows
https://enduro.readthedocs.io/
Apache License 2.0
4 stars 3 forks source link

Problem: name of Temporal workflow and activity functions is inconsistent #519

Open Diogenesoftoronto opened 1 year ago

Diogenesoftoronto commented 1 year ago

Is your feature request related to a problem? Please describe. The current naming conventions for activities and workflows in Enduro can be improved for better consistency and clarity. An unclear or inconsistent naming pattern may lead to confusion and could potentially complicate code management and understanding.

Describe the solution you'd like I propose adopting a more systematic naming pattern for workflow and activity functions. For example, we could rename activities to have "Activity" as a suffix and do the same for workflows (e.g., SendToIngestQueueActivity). This would lead to a consistent and self-explanatory naming convention across all SDPS code, improving readability and manageability.

Describe alternatives you've considered Another approach could be to maintain the current naming scheme, but create a comprehensive mapping or index that clearly outlines the functions of each workflow or activity. However, renaming for direct clarity seems like a more effective solution, minimizing the need for additional resources or documentation.

Additional context Consistency in code is crucial for maintainability and collaboration. By enforcing a strict naming convention, we would be promoting better understanding and ease of use for all developers interacting with the SDPS codebase.

Diogenesoftoronto commented 1 year ago

Should rename activities to have activity as a suffix and the same for workflows