CONTRIBUTING

Every contribution to the Teebeutel project is more than welcome!

You are welcome to add features in the Firmware, fix issues and make changes to the Hardware on the main PCB or create your own Expansions. Help with Documentation, fixing typos, etc. is welcome too.

Things to keep in mind when contributing

• This Projects Hardware is licensed under the CERN-OHL-S-2.0 license.

  • This means your contributions and work based on this project have to be licensed under the CERN-OHL-S-2.0 license as well.

• This Projects Software is licensed under the GPL-3.0 license.

  • This means your contributions and work based on this project have to be licensed under the GPL-3.0 license as well.

• Keep an eye out for the licenses of code you might want to (re)-use.

  • Some licenses may not allow usage in this project due to licensing issues.

• You have to reference the original project your work is based on.

• You have to add a notice about the changes you did:

  • You should add a notice that you did these changes.
  • For example:

    Changes:
    - add capacitor to voltage regulator
    by: @jadyn.dev
    

  • Usually this is taken care by of by GitHub, see below.

GitHub and Commits

• Use Conventional Commits
• When creating pull requests (PR):
  • Explain / list the changes you did.
  • Tag the issues you are closing / working on
• You should sign your commits with a GPG-Key