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

Inconsistent Directory Naming: wolfssh/ide vs wolfssl/IDE #780

Closed
clutch2sft opened this issue Feb 19, 2025 · 4 comments
Closed

Inconsistent Directory Naming: wolfssh/ide vs wolfssl/IDE #780

clutch2sft opened this issue Feb 19, 2025 · 4 comments
Assignees

Comments

@clutch2sft
Copy link

Description:
I’ve observed that the directory structures for wolfssh and wolfssl use different naming conventions for their IDE folders. Specifically, wolfssh places its IDE-related files in wolfssh/ide/ (all lowercase), while wolfssl uses wolfssl/IDE/ (uppercase).

Impact:
This discrepancy could lead to confusion among contributors and might cause issues on case-sensitive file systems. Consistent naming conventions are generally considered a best practice for maintainability and clarity, as noted in various coding style guidelines (e.g., Google's Style Guides and similar resources).

Suggestion:
It might be beneficial to standardize the naming convention across both repositories. Aligning the directory names—either both as ide or both as IDE—would improve consistency and reduce the potential for errors.

@embhorn embhorn self-assigned this Feb 19, 2025
@embhorn
Copy link
Member

embhorn commented Feb 19, 2025

Hello @clutch2sft

Thanks for your interest in wolfSSH. Could you tell us a bit about your project?

I agree that consistency would be helpful. I'll run this past the team, as it would be a relatively quick update.

Thanks,
@embhorn - wolfSSL Support

@gojimmypi
Copy link
Contributor

Although it is indeed unfortunate that the case of IDE is inconsistent between the repositories, and the change would be quick, all of the respective links in scripts, code examples, and issue code references would need to be edited as the GitHub URL paths are case sensitive. See:

working: https://github.com/wolfSSL/wolfssh/tree/master/ide/Espressif

vs

404: https://github.com/wolfSSL/wolfssh/tree/master/IDE/Espressif

@clutch2sft
Copy link
Author

@embhorn Right now I needed an sshclient for some top secret project :-) At the end of the day it is simply a way for me to connect to network devices in a secure manner. But rather than trying to roll my own, and all the complexity that comes with that I found this beautifully coded solution so trying to see if it will work. It's just a playground dream of mine right now but I'll be happy to keep you updated if it gets out of my head into a real project.

@gojimmypi I figured it wouldn't be easy... Just wanted to call it out to gauge the interest. It is just a niggle for me in having to remember which way to make my pinky finger go when traversing the directories.

@embhorn
Copy link
Member

embhorn commented Feb 19, 2025

@clutch2sft

Thanks for the project details. I'll go ahead and close this issue.

@embhorn embhorn closed this as completed Feb 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants