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

#define AUTO_SHIFT_SETUP #8441

Merged
merged 3 commits into from
Aug 15, 2020
Merged

#define AUTO_SHIFT_SETUP #8441

merged 3 commits into from
Aug 15, 2020

Conversation

ThePreviousOne
Copy link
Contributor

@ThePreviousOne ThePreviousOne commented Mar 16, 2020

Description

I added a config option called AUTO_SHIFT_SETUP for autoshift_timer_report autoshift_enable autoshift_disable funtions and KC_ASRP KC_ASUP KC_ASDN keycodes

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

Copy link
Member

@zvecr zvecr left a comment

Choose a reason for hiding this comment

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

I would say the logic of AUTO_SHIFT_SETUP reads badly to what it actually does and should really be renamed. Naming things is always difficult, but its closer to AUTO_SHIFT_NO_SETUP.

Also should we be stripping out the enable/disable functions?

@ThePreviousOne
Copy link
Contributor Author

ThePreviousOne commented Mar 16, 2020

my bad I thought I used #ifdef not #ifndef, it is still tested and does work
is there a preference?

Yes they should, the serve no purpose other than to have dedicated on off keys, I left toggle for that

Changed `#ifndef` to `#ifdef` and moved enable disable outside AUTO_SHIFT_SETUP
@ThePreviousOne
Copy link
Contributor Author

ThePreviousOne commented Mar 16, 2020

I missed the keycodes, force pushed to avoid unnecessary commits in the history

@ThePreviousOne ThePreviousOne requested a review from zvecr March 16, 2020 16:42
@zvecr
Copy link
Member

zvecr commented Mar 16, 2020

I would rather keep the old behaviour as default so we are not silently breaking existing users workflow. Without maintaining the existing contract, it will need to go through the breaking change process.

Going with something like AUTO_SHIFT_NO_SETUP allows us to avoid that.

@ThePreviousOne
Copy link
Contributor Author

ThePreviousOne commented Mar 16, 2020 via email

@zvecr zvecr added the breaking_change Changes that need to wait for a version increment label Mar 17, 2020
@ThePreviousOne
Copy link
Contributor Author

ThePreviousOne commented Mar 17, 2020

I just made the change and went to reflect it in the docs and found Remove AUTO_SHIFT_SETUP from your config.h. on line 142
I didn't add it, it's already there. It's just not in the code.

Am I implementing a feature that has supposed to have existed for a while now?

@ThePreviousOne
Copy link
Contributor Author

@zvecr its no longer a breaking change

@drashna drashna requested a review from a team March 21, 2020 07:02
@drashna drashna requested a review from a team March 29, 2020 19:11
@tzarc tzarc changed the base branch from master to develop July 25, 2020 23:10
@tzarc
Copy link
Member

tzarc commented Jul 25, 2020

Retargeted to develop due to core changes.

Copy link
Member

@noroadsleft noroadsleft left a comment

Choose a reason for hiding this comment

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

Slight __attribute__ ((weak)) ✔️ as I don't use Auto Shift.

@noroadsleft noroadsleft merged commit a9d4e67 into qmk:develop Aug 15, 2020
@noroadsleft
Copy link
Member

Thanks!

For future reference, we recommend against committing to your master branch as you've done here, because pull requests from modified master branches can make it more difficult to keep your QMK fork updated. It is highly recommended for QMK development – regardless of what is being done or where – to keep your master updated, but NEVER commit to it. Instead, do all your changes in a branch (branches are basically free in Git) and issue PRs from your branches when you're developing.

There are instructions on how to keep your fork updated here:

Best Practices: Your Fork's Master: Update Often, Commit Never

Fixing Your Branch will walk you through fixing up your master branch moving forward. If you need any help with this just ask.

Thanks for contributing!

noroadsleft pushed a commit that referenced this pull request Aug 27, 2020
* #define AUTO_SHIFT_SETUP

* Clarification

Changed `#ifndef` to `#ifdef` and moved enable disable outside AUTO_SHIFT_SETUP

* AUTO_SHIFT_NO_SETUp
noroadsleft pushed a commit that referenced this pull request Aug 29, 2020
* #define AUTO_SHIFT_SETUP

* Clarification

Changed `#ifndef` to `#ifdef` and moved enable disable outside AUTO_SHIFT_SETUP

* AUTO_SHIFT_NO_SETUp
nicocesar pushed a commit to nicocesar/qmk_firmware that referenced this pull request Sep 6, 2020
* #define AUTO_SHIFT_SETUP

* Clarification

Changed `#ifndef` to `#ifdef` and moved enable disable outside AUTO_SHIFT_SETUP

* AUTO_SHIFT_NO_SETUp
kjganz pushed a commit to kjganz/qmk_firmware that referenced this pull request Oct 28, 2020
* #define AUTO_SHIFT_SETUP

* Clarification

Changed `#ifndef` to `#ifdef` and moved enable disable outside AUTO_SHIFT_SETUP

* AUTO_SHIFT_NO_SETUp
@ThePreviousOne
Copy link
Contributor Author

This wasn't technically on my master branch I was using a seperate instance in a different location. because at the time I had implemented alot of small breaking changes do to memory constraints in my controller.

BorisTestov pushed a commit to BorisTestov/qmk_firmware that referenced this pull request May 23, 2024
* #define AUTO_SHIFT_SETUP

* Clarification

Changed `#ifndef` to `#ifdef` and moved enable disable outside AUTO_SHIFT_SETUP

* AUTO_SHIFT_NO_SETUp
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking_change Changes that need to wait for a version increment core optimization
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants