Skip to content

Latest commit

 

History

History
24 lines (14 loc) · 999 Bytes

CONTRIBUTING.md

File metadata and controls

24 lines (14 loc) · 999 Bytes

Contributing

Always accepting...

  • Improving the case files and/or adding new cases see, quirks and case
  • Markdown files - fixing typos / grammar or improving clarity, documentation, etc.

If you have another idea, feel free to open an issue for discussion!

Getting Started

Clone this repository with submodules:

git clone --recurse-submodules https://github.com/Daneski13/Junco.git

Make sure you have the latest version of KiCad installed if you want to make changes to the PCB. If you just want to make changes to the case files you may use any software of your choice (a free option is preferred), just provide the raw files in your PR.

Making Changes

Make your changes in a new branch unless you are fixing markdown files. If you are only changing markdown files, you may make your changes on the main branch.

Update the README / documentation the details of your changes as necessary.