Skip to content

Latest commit

 

History

History
46 lines (26 loc) · 2.52 KB

README.md

File metadata and controls

46 lines (26 loc) · 2.52 KB

TactJam-hardware

TactJam setup

TactJam is a collaborative playground for composing spatial tactons. The project is split into the following repositories:

How to contribute

Anyone with the passion for free hardware is welcome to contribute to this project by:

  • 🚀 designing hardware
  • 👾 filing any issues or suggesting new features
  • 🧑‍🏭 sending pull requests for fixed bugs or new features

Before you start, please take a look at the project board and the issues. Maybe there is already a similar bug or feature request that is already under construction and may need your expertise and support.

Branching model

In 2010 Vincent Driessen wrote a nice blog post where he introduced a branching model called git-flow. Over the years it became very popular and was used in many projects. Meanwhile GitHub introduced a much simpler workflow called GitHub flow. Both approaches have their pros and cons. That’s why we use a combination – git-flow as the branching model and the pull request workflow suggested in GitHub flow.

How to commit

To make contribution easier for everyone we like use a common structure of git commit messages:

<type>[optional scope]: <description>
[optional body]
[optional footer(s)]

Please refer to www.conventionalcommits.org for more information.

Copyright

TactJam-hardware is (C) 2020 Tactile Vision

It is licensed under the Creative Commons Attribution license (CC BY4.0). For details, please refer to the LICENSE file.