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

rename kprepublic bm keyboards to have a standardized naming format #15047

Merged
merged 8 commits into from
Nov 17, 2021

Conversation

peepeetee
Copy link
Contributor

@peepeetee peepeetee commented Nov 4, 2021

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:

bm16a
bm16s
bm40hsrgb
bm43a
bm43hsrgb
bm60hsrgb
bm60hsrgb_iso
bm60hsrgb_poker
bm65hsrgb
bm65hsrgb_iso
bm80hsrgb
bm980hsrgb(in flight)

The standardized naming format I've came up with is :
Boards with rgb should be called bmxxrgb, boards with hot swap capability should be called bmxxhs, boards with both should be called bmxxhsrgb.

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

  • Core
  • Bugfix
  • New feature
  • Enhancement/optimization
  • Keyboard (addition or update)
  • Keymap/layout/userspace (addition or update)
  • Documentation

Issues Fixed or Closed by This PR

Checklist

  • My code follows the code style of this project: C, Python
  • I have read the PR Checklist document and have made the appropriate changes.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • I have tested the changes and verified that they work and don't break anything (as well as I can manage).

@github-actions github-actions bot added keyboard keymap via Adds via keymap and/or updates keyboard for via support labels Nov 4, 2021
@peepeetee peepeetee changed the base branch from master to develop November 4, 2021 04:32
@peepeetee
Copy link
Contributor Author

@Deadolus @bitstarr @rgoulter

Copy link

@bitstarr bitstarr left a 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

@tzarc
Copy link
Member

tzarc commented Nov 5, 2021

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.

@peepeetee
Copy link
Contributor Author

please post suggestions to my standardized naming format in the comments, I could really use them

@peepeetee peepeetee changed the title rename kprepublic keyboards to have a standard naming format rename kprepublic keyboards to have a standardized naming format Nov 5, 2021
@bitstarr
Copy link

bitstarr commented Nov 5, 2021

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.

@drashna
Copy link
Member

drashna commented Nov 5, 2021

This has merge conflicts that needs resolution

@peepeetee peepeetee mentioned this pull request Nov 6, 2021
14 tasks
@peepeetee peepeetee closed this Nov 6, 2021
@github-actions github-actions bot removed keymap via Adds via keymap and/or updates keyboard for via support keyboard labels Nov 6, 2021
@peepeetee peepeetee changed the title rename kprepublic keyboards to have a standardized naming format rename kprepublic bm keyboards to have a standardized naming format Nov 7, 2021
@peepeetee peepeetee reopened this Nov 7, 2021
@github-actions github-actions bot added keyboard keymap via Adds via keymap and/or updates keyboard for via support labels Nov 7, 2021
peepeetee added a commit to peepeetee/qmk_firmware that referenced this pull request Nov 7, 2021
@peepeetee
Copy link
Contributor Author

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.

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

@peepeetee
Copy link
Contributor Author

This concerns 2 open PRs.
#15001 by @bdtc123: please put your bm60v2_poker inside bm60hsrgb_poker/rev2
#12852 by @umbacos: rename from bm60ec_rgb to bm60hsrgb_ec

@peepeetee
Copy link
Contributor Author

@zvecr
Copy link
Member

zvecr commented Nov 7, 2021

I am planning to open another pr to fix individual readmes at a later time

Would rather it was done as part of the same PR

@peepeetee
Copy link
Contributor Author

I am planning to open another pr to fix individual readmes at a later time

Would rather it was done as part of the same PR

I currently have #14784 open, and I am unsure of how I should handle merging this pr with #14784, thus the hesitancy

@drashna drashna requested a review from a team November 7, 2021 16:43
@drashna
Copy link
Member

drashna commented Nov 7, 2021

I am planning to open another pr to fix individual readmes at a later time

Would rather it was done as part of the same PR

I currently have #14784 open, and I am unsure of how I should handle merging this pr with #14784, thus the hesitancy

mostly, just:

git checkout kprepublic_rename
git merge kprepublic_readmes
git commit
git push

@peepeetee
Copy link
Contributor Author

I am planning to open another pr to fix individual readmes at a later time

Would rather it was done as part of the same PR

Done, thanks for the suggestion

@tzarc tzarc merged commit c5f1e97 into qmk:develop Nov 17, 2021
@peepeetee peepeetee deleted the kprepublic_rename branch January 16, 2022 14:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
keyboard keymap via Adds via keymap and/or updates keyboard for via support
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants