Skip to content

Latest commit

 

History

History
74 lines (44 loc) · 2.88 KB

CONTRIBUTING.md

File metadata and controls

74 lines (44 loc) · 2.88 KB
Raw

Signing the CLA

Before contributing to this project, you must sign the CLA.

To sign the CLA, add your GitHub username to the end of the CLA. Make sure that the usernames remain alphabetically sorted.

Then create a pull request with the title:

Sign CLA

and with the body:

I have read the Agreement, and fully agree to it by signing it with my GitHub username.

Contributing

Thanks for being willing to contribute to the Ultimate Hacking Keyboard!

Considerations:

  • Unlike plaintext files KiCad files cannot be merged, which means that if multiple people work on the same board at the same time only a single one of them will be able to commit his/her changes and the rest of the changes will be trashed. Because of this, please always open an issue to discuss things before doing any change, so that your efforts won't be wasted.
  • Please make changes on a new feature branch inside your fork, not on master.

Validation

Ensure that the design rules checks pass. The button looks like this:

Errors will be displayed below

Please also make sure that components are not in the 1mm vicinity of the soft keepout areas (the Eco1.User and Eco2.User layers on the left and right main boards). The DRC cannot check for this but it's very important because the components can mechanically interfere with the case.

Visualizing Changes

Before opening the merge request, please run the generate-png-diff.sh script located in the scripts directory. generate-png-diff.sh will automatically a directory named plots and generate about a dozen plots of the pcb 'before' and 'after' the change.

Please include some of the diffs inside the comment section of github

# Assuming you are on a linux system (OSX and Windows users, see Vagrant instructions below)
./scripts/generate-png-diff.sh

The script takes zero, one or two git references to compare against. Arguments can be short/long git refs, branches, or tags. Providing no argument is the same as running generate-png-diff.sh $(git rev-parse --short HEAD)

e.g ./scripts/generate-png-diff.sh

./scripts/generate-png-diff.sh 123456 # Compare current changes against git commit 123456

./scripts/generate-png-diff.sh 67890 123456 # Compare git commit 67890 against git commit 123456

./scripts/generate-png-diff.sh master

./scripts/generate-png-diff.sh $(git rev-parse HEAD^1)

For those who are running OSX / Windows, a Vagrantfile is provided to create an ubuntu 14.04 VM with a shared directory of: /vagrant

  • Install Vagrant
  • Install Virtualbox or VMWare Player
vagrant up
vagrant ssh

cd /vagrant
./scripts/1-add-repos.sh
./scripts/2-install-dependencies.sh
./scripts/generate-png-diff.sh