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

Standardize File Naming Conventions: Replace Mixed Usage of Hyphens and Underscores #172

Open
1 of 4 tasks
wjbmattingly opened this issue Dec 6, 2024 · 1 comment
Open
1 of 4 tasks
Assignees
Labels
enhancement New feature to add to the code Low Low priority task

Comments

@wjbmattingly
Copy link

wjbmattingly commented Dec 6, 2024

Current Status

Currently, our project uses inconsistent naming conventions across files. Some examples:

  • Hyphenated: run-all.sh, run-merge.py
  • Underscored: import_parallel.sh, load_parallel.sh

Problem

This inconsistency:

  • Makes it harder to search for files
  • Reduces code maintainability
  • Creates confusion about which convention to follow for new files
  • Could lead to issues on different operating systems

Proposed Solution

Standardize all file names to use underscores, following Python's PEP 8 style guide. This would mean:

Current Name -> New Name

  • run-all.sh -> run_all.sh
  • run-merge.py -> run_merge.py
  • make-test-dataset.py -> make_test_dataset.py

Files that already use underscores (like import_parallel.sh) would remain unchanged.

Implementation Steps

  1. Create a script to automatically rename files
  2. Update all import statements and file references in the codebase
  3. Update documentation to reflect the new naming convention
  4. Add a linting rule to enforce this convention going forward

Additional Considerations

  • Need to coordinate with team members to ensure no active work on affected files during the rename
  • Should update CI/CD pipelines to verify new naming convention
  • Consider adding to contributing guidelines

Tasks

  • Identify the different patterns
  • Propose a single standard
  • Change filenames This will cause breaking changes
  • Update codebase to prevent breaking changes

Priority

Low

@wjbmattingly
Copy link
Author

Another issue here is the appearance of naming conventions like checkDataUpdates.py.

@wjbmattingly wjbmattingly added the Low Low priority task label Dec 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature to add to the code Low Low priority task
Projects
None yet
Development

No branches or pull requests

2 participants