-
-
Notifications
You must be signed in to change notification settings - Fork 39.8k
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
rename kprepublic bm keyboards to have a standardized naming format #15047
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
please edit the build command in /keyboards/kprepublic/bm43rgb/keymaps/bitstarr/readme.md
Just a note for other collaborators: this missed the deadline for the Nov'21 breaking changes -- it's preferable that this goes in earlier rather than later, so I'm marking it to be included. |
please post suggestions to my standardized naming format in the comments, I could really use them |
i'm fine whith this. it's a good idea to streamline naming. please make sure to edit all readmes too, so nobody gets confused. |
This has merge conflicts that needs resolution |
12f41c4
to
d2ed21c
Compare
I am planning to open another pr to fix individual readmes at a later time, after this has been merged, to minimize work lost if I have to rebase |
Would rather it was done as part of the same PR |
mostly, just: git checkout kprepublic_rename
git merge kprepublic_readmes
git commit
git push |
Done, thanks for the suggestion |
renames
bm60rgb => bm60hsrgb
bm60rgb_iso => bm60hsrgb_iso
bm60poker => bm60hsrgb_poker
bm65rgb => bm65hsrgb
bm65iso => bm65hsrgb_iso
bm68rgb => bm68hsrgb
bm80 => bm80hsrgb
As a result, the directory would look like this:
The standardized naming format I've came up with is :
Boards with rgb should be called
bmxxrgb
, boards with hot swap capability should be calledbmxxhs
, boards with both should be calledbmxxhsrgb
.Varients are denoted by adding a
_
followed by the varient.If the board has neither rgb nor hs, then the varient goes directly after
bmxx
without the_
.Conversely, if it has either rgb or hs, a
_
should be used.Description
Types of Changes
Issues Fixed or Closed by This PR
Checklist