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.

Sign up for GitHub

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

Jump to bottom

Add Herringbone keyboard #9495

Merged
merged 14 commits into from
Jun 28, 2020
Merged

Add Herringbone keyboard #9495

merged 14 commits into from
Jun 28, 2020

Conversation

ramonimbao
Copy link
Contributor

Description

Add Herringbone keyboard with VIA support

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

@ramonimbao ramonimbao changed the title Herringbone Add Herringbone keyboard Jun 21, 2020
zvecr
zvecr requested changes Jun 21, 2020
View reviewed changes
keyboards/herringbone/herringbone.c Outdated Show resolved Hide resolved
keyboards/herringbone/keymaps/iso/keymap.c Outdated Show resolved Hide resolved
keyboards/herringbone/readme.md Outdated Show resolved Hide resolved
keyboards/herringbone/keymaps/via/rules.mk Outdated Show resolved Hide resolved
keyboards/herringbone/keymaps/via/keymap.c Outdated Show resolved Hide resolved
keyboards/herringbone/rules.mk Outdated Show resolved Hide resolved
@zvecr zvecr added the keyboard label Jun 21, 2020
@zvecr zvecr requested a review from a team June 21, 2020 22:03
fauxpark
fauxpark requested changes Jun 22, 2020
View reviewed changes
keyboards/herringbone/config.h Outdated Show resolved Hide resolved
keyboards/herringbone/rules.mk Outdated Show resolved Hide resolved
@ramonimbao
Copy link
Contributor Author

Thanks! I've made the changes. Some sections like the ones found in herringbone.c and the LCD were automatically generated with new_keyboard.sh so I thought not to remove them.

@ramonimbao ramonimbao requested review from zvecr and fauxpark June 23, 2020 09:20
fauxpark
fauxpark requested changes Jun 27, 2020
View reviewed changes
keyboards/herringbone/info.json Outdated Show resolved Hide resolved
Erovia
Erovia requested changes Jun 27, 2020
View reviewed changes
keyboards/herringbone/config.h Outdated
#include "config_common.h"

/* USB Device descriptor parameter */
#define VENDOR_ID 0xB16B
Copy link
Member

Choose a reason for hiding this comment

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

Another keyboard already uses this VID.
That board also has VIA support, so another VID will be needed.

You can check the currently used VID/PID values either here or with git grep.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This particular keyboard is mine too lol. Alright, I thought I could get away with having the same VID but different PID.

Copy link
Member

Choose a reason for hiding this comment

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

Oh, that's a crucial info I did not know, sorry about that.
In this case the same VID would make sense.

If you are planning on creating and contributing other boards (which I hope you do), it would also make sense to create a "vendor" directory and place your boards under it.
This is done the sooner, the better, because for already existing boards it's a breaking change.

tl;dr: You should use the same VID for all your stuff and maybe move this to keyboards/ramonimbao/herringbone.

You wete board should also be moved there, but as I said, it's going to be a breaking change.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm only about to fulfill the boards I've made so far in the local GB I did, but I haven't shipped them out yet. Will this be not be considered a breaking change anymore in that case? The only ones that have the PCBs so far are me and another local guy.

Copy link
Member

Choose a reason for hiding this comment

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

I think this can be an exception, but the others will weigh in on it.
I recommend doing the move as soon as possible in this case.

keyboards/herringbone/keymaps/iso/rules.mk Outdated Show resolved Hide resolved
@ramonimbao ramonimbao mentioned this pull request Jun 28, 2020
Merged
13 tasks
@Erovia
Copy link
Member

Erovia commented Jun 28, 2020

Could you do that git mv here, too?
Currently this PR has both keyboards/herringbone and keyboards/ramonimbao/herringbone.

Erovia
Erovia requested changes Jun 28, 2020
View reviewed changes
keyboards/ramonimbao/herringbone/config.h Outdated Show resolved Hide resolved
@Erovia Erovia requested a review from a team June 28, 2020 14:25
@Erovia Erovia requested a review from fauxpark June 28, 2020 14:30
@Erovia Erovia requested a review from a team June 28, 2020 14:30
@Erovia Erovia merged commit 32a47e7 into qmk:master Jun 28, 2020
@ramonimbao ramonimbao mentioned this pull request Jun 28, 2020
Merged
@ramonimbao ramonimbao deleted the herringbone branch June 29, 2020 01:29
jakobaa pushed a commit to jakobaa/qmk_firmware that referenced this pull request Jul 7, 2020
@ramonimbao @fauxpark
@Erovia @jakobaa
Add Herringbone keyboard (qmk#9495)
25fa09b 
Co-authored-by: Ryan <[email protected]>
Co-authored-by: Erovia <[email protected]>
@ramonimbao ramonimbao mentioned this pull request Aug 21, 2020
Merged
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fauxpark fauxpark fauxpark approved these changes

@Erovia Erovia Erovia approved these changes

@zvecr zvecr Awaiting requested review from zvecr

Assignees
No one assigned
Labels
keyboard
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@ramonimbao @Erovia @fauxpark @zvecr