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

Partial cleanup of Q3 to assist merge into QMK. #73

Merged
merged 1 commit into from
Oct 8, 2022

Conversation

tzarc
Copy link

@tzarc tzarc commented Oct 6, 2022

This should serve as an example on how to simplify the Keychron modifications and reduce a significant amount of the duplication between boards.

As per the PR Checklist, default/via keymaps are now minimal.
Equivalent keychron_default and keychron_via keymaps now exist which should keep the original functionality, which has been broken out into a higher-level keychron_common and made available for use by all boards with a single implementation.

Please replicate the same changes for all other boards in this PR. If you feel the need to update existing boards in the repository, please raise those as a separate PR.

@tzarc tzarc changed the title Cleanup Q3 to assist merge into QMK. Partial cleanup of Q3 to assist merge into QMK. Oct 6, 2022
@KeychronMacro KeychronMacro merged commit 0091b79 into Keychron:keychron-q3 Oct 8, 2022
@adophoxia
Copy link

Looking at the new keymap folders, is there a reason there has to be a keychron_[default/via] folder to use #include "keychron_common.h inside their keymap.c files instead of sticking it inside the ones in the [default/via] folders that are already there?

@tzarc tzarc deleted the q3-pr-fixes branch October 8, 2022 03:18
@tzarc
Copy link
Author

tzarc commented Oct 8, 2022

@adophoxia covered in the description already.

@adophoxia
Copy link

Ah ok. Didn't notice that earlier.

@silvinor
Copy link

silvinor commented Oct 8, 2022

@lokher - As Keychron would not deploy a "default" variant of their own code, having both "keychron_default" and "keychron_via" would just be redundancy on the code. To me, it makes more sense to drop the "keychron_default" variant and the rename "keychron_via" to just "keychron".

This way you would have default, via, and keychron keymap folders - and users would know that the "keychron" one is the build that comes to them from factory.

@lokher
Copy link
Member

lokher commented Oct 11, 2022

@lokher - As Keychron would not deploy a "default" variant of their own code, having both "keychron_default" and "keychron_via" would just be redundancy on the code. To me, it makes more sense to drop the "keychron_default" variant and the rename "keychron_via" to just "keychron".

This way you would have default, via, and keychron keymap folders - and users would know that the "keychron" one is the build that comes to them from factory.

that make sense, thank you.

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