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

[Keymap] add userspace folder, adding and updating keymaps. #20437

Closed
wants to merge 160 commits into from

Conversation

mkillewald
Copy link
Contributor

@mkillewald mkillewald commented Apr 13, 2023

Description

  • Adding userspace folder users/mkillewald
  • Adding keymap keychron/q2/ansi_encoder/keymaps/mkillewald (stm32l432)
  • Adding keymap keychron/q1/ansi_encoder/keymaps/mkillewald (atmega32u4)
  • Updating keymap keychron/q1/ansi/keymaps/mkillewald (atmega32u4)
  • Renaming keychron/q1/iso/keymaps/mkillewald_iso to /keymaps/mkillewald and updating keymap to match version and features of ANSI keymap

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

@adophoxia
Copy link
Contributor

Opening and closing new PRs isn't going to help this one as fragmentation will occur if this goes on. I suggest you stick to your previous PR and work from there.

@mkillewald
Copy link
Contributor Author

Sorry, If I've done something wrong. I'm a lone amateur developer figuring things out as I go. I've deleted the branch the previous PR was based off of. This branch has my updated code with newer features. My thinking was to close the previous PR and delete the old branch since the code was outdated rather then to let it get merged and then come back and update it with this one. Perhaps, I should have merged this new feature branch with the old one on the old PR.

@mkillewald
Copy link
Contributor Author

mkillewald commented Apr 25, 2023

Have added userspace folder.

@mkillewald mkillewald force-pushed the mkillewald_q2_custom branch from a1a3a78 to 9bc91d1 Compare April 29, 2023 14:34
@mkillewald mkillewald changed the title [Keymap] keychron/q2/ansi_encoder Keychron Q2 with knob (stm32l432) [Keymap] adding keymap keychron/q2/ansi_encoder(stm32l432), updating keymap keychron/q1/ansi Apr 29, 2023
@mkillewald mkillewald changed the title [Keymap] adding keymap keychron/q2/ansi_encoder(stm32l432), updating keymap keychron/q1/ansi [Keymap] adding keymap keychron/q2/ansi_encoder(stm32l432), updating keymap keychron/q1/ansi (atmega32u4) Apr 29, 2023
@mkillewald mkillewald changed the title [Keymap] adding keymap keychron/q2/ansi_encoder(stm32l432), updating keymap keychron/q1/ansi (atmega32u4) [Keymap] add userspace folder, add keymap keychron/q2/ansi_encoder, update keymap keychron/q1/ansi Apr 29, 2023
@mkillewald mkillewald changed the title [Keymap] add userspace folder, add keymap keychron/q2/ansi_encoder, update keymap keychron/q1/ansi [Keymap] add userspace folder, add keymap q2/ansi_encoder, add keymap q1/ansi_encoder, update keymap q1/ansi Apr 29, 2023
@mkillewald
Copy link
Contributor Author

mkillewald commented Apr 29, 2023

I previously had created separate branches for each keyboard I was working on with separate PRs to boot. I have now merged my branches (mkillewald_q1 and mkillewald_q1se) into this branch (mkillewald_q2_custom) for a single PR.

@mkillewald mkillewald changed the title [Keymap] add userspace folder, add keymap q2/ansi_encoder, add keymap q1/ansi_encoder, update keymap q1/ansi [Keymap] add userspace folder, adding and updating keymaps. May 10, 2023
@@ -0,0 +1,176 @@
// Copyright 2023 QMK
Copy link
Member

Choose a reason for hiding this comment

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

You should move this to your userspace. It will still get picked up there, and you don't have to have 10 copies of it

Copy link
Contributor Author

@mkillewald mkillewald May 12, 2023

Choose a reason for hiding this comment

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

@drashna I am using two different dictionary files, the 400 entry and the smaller 77 entry file. I've moved the 400 entry dictionary into my userspace folder because I would like this to be my default for in the future. Unfortunately, at this time, I have only one keymap (the q2) that utilizes the 400 entry dictionary. The Q1 keymaps (using the atmega32u4) are utilizing the smaller 77 entry file because they are near the firmware size limit. So I still have many copies of the same file. Perhaps there is a way to move both dictionary files to the userspace folder and specify which dictionary file to pull from?

Copy link
Member

Choose a reason for hiding this comment

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

you can still use the same file for both. Eg:

#if defined(__AVR__)
// avr friendly dictionary
#else
// arm dictionary
#endif

This would allow you to have one file for both configs. Either option is fine, though.

keyboards/keychron/q1/ansi/keymaps/mkillewald/keymap.c Outdated Show resolved Hide resolved
keyboards/keychron/q1/ansi/keymaps/mkillewald/readme.md Outdated Show resolved Hide resolved
users/mkillewald/eeprom_user_config.c Show resolved Hide resolved
users/mkillewald/eeprom_user_config.c Outdated Show resolved Hide resolved
users/mkillewald/mkillewald.c Outdated Show resolved Hide resolved
users/mkillewald/mkillewald.h Outdated Show resolved Hide resolved
users/mkillewald/myfork_keychron_ft.c Outdated Show resolved Hide resolved
@mkillewald mkillewald requested a review from drashna May 17, 2023 13:31
@mkillewald
Copy link
Contributor Author

mkillewald commented May 17, 2023

Will be adding a q1v2 keymap to this if/when #20416 is merged

@drashna drashna requested a review from a team July 4, 2023 00:17
@github-actions
Copy link

Thank you for your contribution!
This pull request has been automatically marked as stale because it has not had activity in the last 45 days. It will be closed in 30 days if no further activity occurs. Please feel free to give a status update now, or re-open when it's ready.
For maintainers: Please label with bug, awaiting review, breaking_change, in progress, or on hold to prevent the issue from being re-flagged.

@github-actions github-actions bot added the stale Issues or pull requests that have become inactive without resolution. label Aug 18, 2023
@zvecr
Copy link
Member

zvecr commented Aug 29, 2023

Unfortunately since this PRs creation, QMK has changed its stance on accepting user keymaps to the repository.

qmk/qmk_firmware is no longer accepting PRs for keymaps other than for manufacturer-supported keymaps. User keymap workflow has been documented here for several years. This change is to progressively reduce the maintenance burden on the project, and to allow us to focus on the core features of QMK.

In the near future we will be providing a more user focused workflow for keymaps, but till then the suggestion is to keep changes in your own fork.

While we appreciate the time that was taken on this PR, hopefully you understand we are closing it, so that QMK can improve in the long term.

@zvecr zvecr closed this Aug 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
keymap stale Issues or pull requests that have become inactive without resolution.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants