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

Uniform Usage of Directory Path Constants Across EVE Codebase #3682

Open
5 tasks
OhmSpectator opened this issue Dec 15, 2023 · 0 comments
Open
5 tasks

Uniform Usage of Directory Path Constants Across EVE Codebase #3682

OhmSpectator opened this issue Dec 15, 2023 · 0 comments
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@OhmSpectator
Copy link
Contributor

Description

The codebase currently exhibits inconsistencies in the use of directory path constants. While some parts of the code utilize constants defined in eve/pkg/pillar/types/locationconsts.go, others hardcode the paths directly. This enhancement aims to standardize the use of directory path constants across the entire codebase, ensuring consistency, reducing potential for errors, and facilitating easier maintenance and future updates.

Requirements

  • Identify all instances in the code where directory paths are hardcoded instead of using constants from locationconsts.go.
  • Refactor these instances to use the appropriate constants defined in locationconsts.go.
  • Ensure that all new code submissions adhere to this standard by updating contribution guidelines.
  • Perform thorough testing to confirm that changes do not introduce any new issues or regressions.
  • Document the changes and rationale in relevant sections of the project documentation.

Additional Information

This task requires a comprehensive review of the entire EVE codebase, which may affect multiple components and modules. The refactor should be conducted with careful consideration to avoid introducing any breaking changes. It is recommended to proceed incrementally, module by module, to manage the scope effectively. Contributors are encouraged to refer to the locationconsts.go file for the list of available constants and to ensure alignment with the latest version of the codebase.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant