Skip to content

Commit

Permalink
docs: Provide a contribution guide
Browse files Browse the repository at this point in the history
  • Loading branch information
AiyionPrime committed Jan 3, 2025
1 parent afb902d commit e2b5058
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
Contributing

Help is highly appreciated, if you've got questions feel free to ask.
We're generally reachable in IRC hackint#freifunkh.



Commit style

This repo uses so called conventional commits.
Which implies, that the commit messages follow a certain style, which can be learned easily and helps building changelogs and cleaner software in general.



CI/CD is favored

While we're currently not at this point, we'd like to see GitHub actions validate the contents and deploy them upon changes on main.



Hard Fork contributions

This project is largely based on @lemoer's work for the LeineLab,our local Hacker Space.
There is currently no planned effort to backport fixes and changes, which would be questionable at best due to currently lacking abstractions, but surely won't happen until the LeineLab does publicizes the fork.

Thanks for the work @lemoer!

0 comments on commit e2b5058

Please sign in to comment.