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

Developer Experience: File name schema change suggestion #133

Open
flickerfly opened this issue Oct 26, 2022 · 0 comments · May be fixed by #134
Open

Developer Experience: File name schema change suggestion #133

flickerfly opened this issue Oct 26, 2022 · 0 comments · May be fixed by #134

Comments

@flickerfly
Copy link
Contributor

This may come from a lack of understanding of the actual user base of this product so feel free to refute.

In my opinion, working with the files in the Arduino IDE would be much easier if the specific hardware files were grouped together and the most frequently changed by new people were gathered together at the top. I'd call the second group the primary config files.

Towards that end, I'd like to suggest that the hardware name be a prefix instead of a suffix and that keyer_pin_settings.h, keyer_settings.h and keyer_features_and_options.h have the keyer_ prefix changed to config_ which would bring it to the top. When displayed in the Arduino IDE 2.0.0, it would have the most important files in tabs visible to the new user instead of behind the ... button. Also, if you're working with specific hardware, you'll have them grouped for easy finding also

We'd end up with a file listing like below resulting in less hunting for the most commonly used files.

config_feature_and_options.h
config_pin_settings.h
config_setings.h
k3ng_keyer.ino
keyer.h
keyer_callsign_prefixes.h
keyer_debug.h
keyer_dependencies.h
...
mortty_keyer_feature_and_options.h
mortty_keyer_pin_settings.h
mortty_keyer_settings.h
...
yaacwk_keyer_features_and_options.h
yaacwk_keyer_pin_settings.h_
yaacwk_keyer_settings.h

If this is interesting to the community, I'm willing to take on a push request. I should be able to script it into shape pretty quick.

@flickerfly flickerfly linked a pull request Oct 26, 2022 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant