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

[Feature Request] Reorganize the Sofle family folders #16829

Closed
1 of 4 tasks
brianlow opened this issue Apr 9, 2022 · 9 comments
Closed
1 of 4 tasks

[Feature Request] Reorganize the Sofle family folders #16829

brianlow opened this issue Apr 9, 2022 · 9 comments
Labels
enhancement help wanted stale Issues or pull requests that have become inactive without resolution.

Comments

@brianlow
Copy link
Contributor

brianlow commented Apr 9, 2022

Reorganize the sofle code so keymaps are specific to hardware variation, all organized under a top level sofle folder

Feature Request Type

  • Core functionality
  • Add-on hardware support (eg. audio, RGB, OLED screen, etc.)
  • Alteration (enhancement/optimization) of existing feature(s)
  • New behavior

Description

Proposed folder structure:

keyboards/sofle/              # no code in this folder, just for grouping the family

    original/                 # moved from sofle/rev1                 
      keymaps/                      
        default/     
        flare56/              # no RGB code, so assume for the Sofle v1/v2
        helltm                # no RGB code, so assume for the Sofle v1/v2
        j4ckofalltrade        # no RGB code, so assume for the Sofle v1/v2
        killmaster            # no RGB code, so assume for the Sofle v1/v2
        manna-harbour_miryoku # no RGB code, so assume for the Sofle v1/v2

    rgb/                      # copy of sofle/rev1
      keymaps/
        default/              # renamed from rgb_default
        devdev/               # has RGB code, so assume for the Sofle RGB

    keyhive                   
      keymaps/
        default/              # copy of the current default keymap
        via/                  # renamed from keyhive_via

    choc                      # moved from from keyboards/sofle_choc
      keymaps
        default/
        via/   

Background

  • When adding Sofle Choc support it was noticed that keymaps are organized under what I believe is an old folder structure (see PR comment). The recommended structure is /keymaps/family/hardware-variant/keymaps

Pros

  • keymaps are specific to the hardware variant
  • hardware variants no longer share code so changes are isolated
  • better CI since default/via keymaps will be built against hardware-variant specific code
  • organized under a single family folder for easier discovery

Happy to make this change but want approval from hardware maintainers. If I don't heard back after a month I'll assume you are no longer maintaining and are ok with the change.

@winder
Copy link

winder commented Apr 10, 2022

This proposal looks good to me.

@josefadamcik
Copy link
Contributor

Looks great to me, thanks for doing this!

@github-actions
Copy link

This issue has been automatically marked as stale because it has not had activity in the last 90 days. It will be closed in the next 30 days unless it is tagged properly or other activity occurs.
For maintainers: Please label with bug, in progress, on hold, discussion or to do 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 15, 2022
@duese
Copy link

duese commented Aug 15, 2022

This issue is not stale. I created a PR (#17979) 5 days ago according to the proposal of @brianlow. I'm not sure how the process is now, who needs to review/approve that PR?

@github-actions github-actions bot removed the stale Issues or pull requests that have become inactive without resolution. label Aug 16, 2022
@waffle87
Copy link
Member

a collaborator who has some free time to review it. tldr; just need to be patient now.

@github-actions
Copy link

This issue has been automatically marked as stale because it has not had activity in the last 90 days. It will be closed in the next 30 days unless it is tagged properly or other activity occurs.
For maintainers: Please label with bug, in progress, on hold, discussion or to do 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 Nov 15, 2022
@github-actions
Copy link

This issue has been automatically closed because it has not had activity in the last 30 days. If this issue is still valid, re-open the issue and let us know.
// [stale-action-closed]

@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Dec 16, 2022
@ireun
Copy link
Contributor

ireun commented Apr 25, 2023

Any progress with that?

@duese
Copy link

duese commented Apr 25, 2023

Any progress with that?

I'm waiting for PR #16736 being accepted and merged. Than we can continue on restructuring the sofle family.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement help wanted stale Issues or pull requests that have become inactive without resolution.
Projects
None yet
Development

No branches or pull requests

6 participants