Skip to content

Latest commit

 

History

History
28 lines (22 loc) · 1016 Bytes

CONTRIBUTING.md

File metadata and controls

28 lines (22 loc) · 1016 Bytes

CONTRIBUTING

Every contribution to the GPN-Badge-Printer is more than welcome!

Things to keep in mind when contributing

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

  • 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 / copyright 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