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

Align Code to QMK Coding Guidelines for keyboard_post_init_user() #40

Open
wants to merge 3 commits into
base: fl16-v0.2.8-prep
Choose a base branch
from

Conversation

heumann-a
Copy link

@heumann-a heumann-a commented Jul 6, 2024

As mentioned in the QMK Guidelines all _user() functions should optimally (in best case never) used by the keyboards to be available for the keymap / user to implement own stuff.

Description

In your Macropad and Numpad keyboard you used keyboard_post_init_user() which should be used on keymap instead of keyboard level. For this i moved the functions to their respective default keymap, where they should be. The same or even more is important for layers which are specific for each keymap and should definitely only defined inside the respective keymaps (user-wide keymaps are an exception but since this is a keyboard folder, it is not applicable)

This Default keymap also serves as template to create an own keymap layout, so the code is still visible for everyone who wants to create or fork from it.

Types of Changes

  • Core
  • Bugfix
  • Enhancement/optimization

Issues Fixed or Closed by This PR

  • Compiler Error about multiple definitions of keyboard_post_init_user()
  • Move layout to keymap
  • EDIT: added funtionality to avoid triggering an event-drive layer-function permanently due syncing of numlock

Checklist

  • I have tested the changes and verified that they work and don't break anything (as well as I can manage).

PS: If approved and considered correct, pls ping me and i would like to fix the other _user() functions too, that i found. Want to avoid doing multiple PRs for nothing if you guys think otherwise and remodel it differently.

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 label Aug 21, 2024
@heumann-a
Copy link
Author

Not stale. still waiting for review

@github-actions github-actions bot removed the stale label Aug 22, 2024
Copy link

github-actions bot commented Oct 9, 2024

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 label Oct 9, 2024
@benedikt-bartscher
Copy link

not stale

@github-actions github-actions bot removed the stale label Oct 19, 2024
Copy link

github-actions bot commented Dec 3, 2024

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 label Dec 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants