Arduino-IRremote · ArminJo · Jun 17, 2020 · Aug 10, 2017 · Aug 10, 2017 · Aug 13, 2017
diff --git a/.github/workflows/LibraryBuild.yml b/.github/workflows/LibraryBuild.yml
@@ -0,0 +1,102 @@
+# LibraryBuild.yml
+# Github workflow script to test compile all examples of an Arduino library repository.
+#
+# Copyright (C) 2020  Armin Joachimsmeyer
+# https://github.com/ArminJo/Github-Actions
+#
+# Before being able to push to my .github\workflows directories,
+# I had to create a new personal token with workflow enabled at https://github.com/settings/tokens
+
+# This is the name of the workflow, visible on GitHub UI.
+name: LibraryBuild
+on:  
+  push: # see: https://help.github.com/en/actions/reference/events-that-trigger-workflows#pull-request-event-pull_request
+    paths:
+    - '**.ino'
+    - '**.cpp'
+    - '**.h'
+    - '**LibraryBuild.yml'
+  pull_request:
+    paths:
+    - '**.ino'
+    - '**.cpp'
+    - '**.h'
+    - '**LibraryBuild.yml'
+
+jobs:
+  build:
+    name: ${{ matrix.arduino-boards-fqbn }} - test compiling examples
+
+    runs-on: ubuntu-18.04 # I picked Ubuntu to use shell scripts.
+
+    env:
+      # Comma separated list without double quotes around the list. 
+      REQUIRED_LIBRARIES:
+
+    strategy:
+      matrix:
+        # The matrix will produce one job for each configuration parameter of type `arduino-boards-fqbn`
+        # In the Arduino IDE, the fqbn is printed in the first line of the verbose output for compilation as parameter -fqbn=... for the "arduino-builder -dump-prefs" command
+        #
+        # Examples: arduino:avr:uno, arduino:avr:leonardo, arduino:avr:nano, arduino:avr:mega
+        # arduino:sam:arduino_due_x, arduino:samd:arduino_zero_native"
+        # ATTinyCore:avr:attinyx5:chip=85,clock=1internal, digistump:avr:digispark-tiny, digistump:avr:digispark-pro
+        # STM32:stm32:GenF1:pnum=BLUEPILL_F103C8
+        # esp8266:esp8266:huzzah:eesz=4M3M,xtal=80, esp32:esp32:featheresp32:FlashFreq=80
+        # You may add a suffix behind the fqbn with "|" to specify one board for e.g. different compile options like arduino:avr:uno|trace
+        #############################################################################################################
+        arduino-boards-fqbn:
+          - arduino:avr:uno
+          - arduino:avr:leonardo
+          - arduino:samd:arduino_zero_native
+          - esp32:esp32:featheresp32:FlashFreq=80
+          - SparkFun:avr:promicro
+
+        # Specify parameters for each board.
+        # With examples-exclude you may exclude specific examples for a board. Use a comma separated list.
+        #############################################################################################################
+        include:
+          - arduino-boards-fqbn: arduino:avr:uno
+            examples-build-properties:
+              AiwaRCT501SendDemo: -DSEND_AIWA_RC_T501
+              IRrecord: -DSEND_NEC -DSEND_SONY -DSEND_RC5 -DSEND_RC6
+              IRsendDemo: -DSEND_SONY
+              IRtest: -DSEND_NEC -DSEND_SONY -DSEND_RC5 -DSEND_RC6
+              IRtest2: -DSEND_NEC -DSEND_SONY -DSEND_RC5 -DSEND_RC6
+              JVCPanasonicSendDemo: -DSEND_JVC -DSEND_PANASONIC
+              LegoPowerFunctionsSendDemo: -DSEND_LEGO_PF
+              LegoPowerFunctionsTests: -DSEND_LEGO_PF
+
+          - arduino-boards-fqbn: esp32:esp32:featheresp32:FlashFreq=80
+            platform-url: https://dl.espressif.com/dl/package_esp32_index.json
+            examples-exclude: AiwaRCT501SendDemo,IRrecord,IRsendDemo,IRsendRawDemo,IRtest,IRtest2,JVCPanasonicSendDemo,LegoPowerFunctionsSendDemo,LGACSendDemo # Comma separated list of (unique substrings of) example names to exclude in build
+
+          - arduino-boards-fqbn: SparkFun:avr:promicro
+            arduino-platform: arduino:avr,SparkFun:avr
+            platform-url: https://raw.githubusercontent.com/sparkfun/Arduino_Boards/master/IDE_Board_Manager/package_sparkfun_index.json # Arduino URL is not required here
+
+
+      # Do not cancel all jobs / architectures if one job fails
+      fail-fast: false
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@master
+
+      # Use the arduino-test-compile script, because it is faster
+      - name: Compile all examples using the bash script arduino-test-compile.sh
+        env:
+          # Passing parameters to the script by setting the appropriate ENV_* variables.
+          ENV_ARDUINO_BOARD_FQBN: ${{ matrix.arduino-boards-fqbn }}
+          ENV_ARDUINO_PLATFORM: ${{ matrix.arduino-platform }}
+          ENV_PLATFORM_URL: ${{ matrix.platform-url }}
+          ENV_REQUIRED_LIBRARIES: ${{ env.REQUIRED_LIBRARIES }}
+          ENV_EXAMPLES_EXCLUDE: ${{ matrix.examples-exclude }}
+          ENV_EXAMPLES_BUILD_PROPERTIES: ${{ toJson(matrix.examples-build-properties) }}
+#          ENV_DEBUG_INSTALL: true
+
+        run: |
+          wget --quiet https://raw.githubusercontent.com/ArminJo/arduino-test-compile/master/arduino-test-compile.sh
+            ls -l arduino-test-compile.sh
+            chmod +x arduino-test-compile.sh
+            ./arduino-test-compile.sh
diff --git a/.travis.yml b/.travis.yml
diff --git a/Contributing.md b/Contributing.md
@@ -1,11 +1,13 @@
-# Contribution Guidlines
+# Contribution Guidelines
 
 This library is the culmination of the expertise of many members of the open source community who have dedicated their time and hard work. The best way to ask for help or propose a new idea is to [create a new issue](https://github.com/z3t0/Arduino-IRremote/issues/new) while creating a Pull Request with your code changes allows you to share your own innovations with the rest of the community.
 
 The following are some guidelines to observe when creating issues or PRs:
 - Be friendly; it is important that we can all enjoy a safe space as we are all working on the same project and it is okay for people to have different ideas
-- [Use code blocks](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#code); it helps us help you when we can read your code! On that note also refrain from pasting more than 30 lines of code in a post, instead [create a gist](https://gist.github.com/) if you need to share large snippets
+- [Use code blocks](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#code); **it helps us help you when we can read your code!** On that note also refrain from pasting more than 30 lines of code in a post, instead **[create a gist](https://gist.github.com/) if you need to share large snippets**
 - Use reasonable titles; refrain from using overly long or capitalized titles as they are usually annoying and do little to encourage others to help :smile:
-- Be detailed; refrain from mentioning code problems without sharing your source code and always give information regarding your board and version of the library 
+- Be detailed; refrain from mentioning code problems without sharing your source code and always give information regarding your board and version of the library
+- Use the style; we use the original [C Style by Kerninghan / Ritchie](https://en.wikipedia.org/wiki/Indentation_style#K&R_style) in [variant: 1TBS (OTBS)](https://en.wikipedia.org/wiki/Indentation_style#Variant:_1TBS_(OTBS)). In short: 4 spaces indentation, no tabs, opening braces on the same line, rraces are mandatory on all if/while/do, no hard line length limit. To beautify your code, you may use the online formatter [here](https://www.freecodeformat.com/c-format.php).
+- Choose the right Pull Request target; if you only have **minor changes or adding a new protocol**, choose **master** as target for your Pull Request. If have a change **addressing more general aspects** of this library or think, that the PR should be **discussed and reviewed**, choose the **dev** branch as target for your Pull Request like described [here](https://guides.github.com/introduction/flow/).
 
 If there is any need to contact me then you can find my email on the README, I do not mind responding to emails but it would be in your own interests to create issues if you need help with the library as responses would be from a larger community with greater knowledge!
diff --git a/Contributors.md b/Contributors.md
@@ -18,5 +18,7 @@ These are the active contributors of this project that you may contact if there
 - [philipphenkel](https://github.com/philipphenkel): Active Contributor
 - [MCUdude](https://github.com/MCUdude): Contributor
 - [marcmerlin](https://github.com/marcmerlin): Contributor (ESP32 port)
+- [bengtmartensson](https://github.com/bengtmartensson): Active Contributor
+- [MrBryonMiller](https://github.com/MrBryonMiller): Contributor
 
 Note: This list is being updated constantly so please let [z3t0](https://github.com/z3t0) know if you have been missed.