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

Adding standard keymap for wave keyboard to fix #22695 #22741

Merged
merged 9 commits into from
Mar 22, 2024

Conversation

etiennecollin
Copy link
Contributor

Description

The wave keyboard had a feature keymap which was truly ready to use, but it was deleted by #22695 . I am therefore adding it once again, this time as the standard keymap to be coherent with the naming conventions.

This standard keymap is needed on top of the default one because the default keymap cannot use special features (such as home-row mods) which make a 36 key keyboard truly usable.

Types of Changes

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

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

This keymap was deleted by qmk#22695 .
@filterpaper
Copy link
Contributor

Mod-tap keys are permitted in the default keymap.

@etiennecollin
Copy link
Contributor Author

etiennecollin commented Dec 27, 2023

Mod-tap keys are permitted in the default keymap.

The keymap also features:

  • Caps words
  • Home row mods
  • Multiple layouts on different layers (colemak, qwerty and gaming)
  • Multiple layers (media, mouse, numbers, symbols, etc),
  • Combos
  • BOTH_SHIFTS_TURNS_ON_CAPS_WORD

Would that all be accepted for the default keymap? Initially, this is why I offered a feature keymap.
Thank you for your time.

@filterpaper
Copy link
Contributor

Self hosted userspace might be the right place for feature rich keymaps: #22724

@lesshonor
Copy link
Contributor

lesshonor commented Dec 27, 2023

The keymap also features:

* Caps words

* Home row mods

* Multiple layouts on different layers (colemak, qwerty and gaming)

* Multiple layers (media, mouse, numbers, symbols, etc),

* Combos

* `BOTH_SHIFTS_TURNS_ON_CAPS_WORD`

Would that all be accepted for the default keymap? Initially, this is why I offered a feature keymap. Thank you for your time.

My understanding is that the only feature in this list which would not be allowed is the combos.

@etiennecollin
Copy link
Contributor Author

Self hosted userspace might be the right place for feature rich keymaps: #22724

Thank you for the link, this is something new. #22724 mentions vendor keymaps; I believe I classify as a vendor since I am the creator/maintainer/designer of this keyboard.

I would like to offer a fully featured, usable keymap to everyone who either buys or builds my keyboard.
Should I simply contact QMK Collaborators on Discord?
Thanks!

@etiennecollin
Copy link
Contributor Author

etiennecollin commented Dec 27, 2023

The keymap also features:

* Caps words

* Home row mods

* Multiple layouts on different layers (colemak, qwerty and gaming)

* Multiple layers (media, mouse, numbers, symbols, etc),

* Combos

* `BOTH_SHIFTS_TURNS_ON_CAPS_WORD`

Would that all be accepted for the default keymap? Initially, this is why I offered a feature keymap. Thank you for your time.

My understanding is that the only feature in this list which would not be allowed is the combos.

If that is the case, then I guess that by setting this keymap as the default one, I wouldn't be straying really far from the rules. I will try to replace the combos by something else if possible.

@etiennecollin
Copy link
Contributor Author

Hello!
I just replaced the default keymap with the feature one because the latter is not allowed anymore. The goal is, as the creator of this 34 key split keyboard, to provide a usable keymap by default.
Let me know if you believe I should change something.

@drashna drashna requested a review from a team February 1, 2024 07:27
Copy link
Member

@fauxpark fauxpark left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Keyboard updates need to go through develop.

@etiennecollin
Copy link
Contributor Author

Keyboard updates need to go through develop.

To make sure I understand, I am to merge this PR into the develop branch and then that branch will be merged at some point in master?

@fauxpark
Copy link
Member

fauxpark commented Feb 1, 2024

Yes.
https://docs.qmk.fm/#/pr_checklist?id=keyboard-prs

keyboard updates and refactors (eg. to data driven) must go through develop to reduce master -> develop merge conflicts

@etiennecollin etiennecollin changed the base branch from master to develop February 1, 2024 21:13
@etiennecollin
Copy link
Contributor Author

@drashna @fauxpark Hi, I just want to make sure: is this PR missing something to be merged? Thank you for your time!

@fauxpark fauxpark merged commit c038292 into qmk:develop Mar 22, 2024
3 checks passed
@etiennecollin etiennecollin deleted the etiennecollin-wave-feature-keymap branch March 22, 2024 21:24
whoisjordangarcia pushed a commit to whoisjordangarcia/qmk_firmware that referenced this pull request Jun 8, 2024
nuess0r pushed a commit to nuess0r/qmk_firmware that referenced this pull request Sep 8, 2024
Ardakilic pushed a commit to Ardakilic/qmk_firmware that referenced this pull request Sep 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants