k3ng / k3ng_cw_keyer

K3NG Arduino CW Keyer
http://blog.radioartisan.com/arduino-cw-keyer/
GNU General Public License v3.0
416 stars 216 forks source link

Developer Experience: File name schema change suggestion #133

Open flickerfly opened 1 year ago

flickerfly commented 1 year ago

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_andoptions.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.