You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+13-6Lines changed: 13 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,11 +6,9 @@
6
6
7
7
* Before making contributions, understand the purpose and functionality of the Pi4Micronaut library.
8
8
9
-
* Review the library documentation, any related articles, or tutorials.
10
-
11
-
Our documentation can be found online at [oss-slu.github.io/Pi4Micronaut](https://oss-slu.github.io/Pi4Micronaut/). Good information and tutorials on Raspberry Pis and electronic components can be found online from [Sunfounder](https://docs.sunfounder.com/en/latest/), [SparkFun](https://learn.sparkfun.com/), or others.
12
-
13
-
This file will go over some quick information about our library, but please refer to our documentation webpage for more complete information.
9
+
* Review the library documentation, any related articles, or tutorials.
10
+
* Our documentation can be found online at [oss-slu.github.io/Pi4Micronaut](https://oss-slu.github.io/Pi4Micronaut/). Good information and tutorials on Raspberry Pis and electronic components can be found online from [Sunfounder](https://docs.sunfounder.com/en/latest/), [SparkFun](https://learn.sparkfun.com/), or others.
11
+
* This file will go over some quick information about our library, but please refer to our documentation webpage for more complete information.
14
12
15
13
### Set Up Your Development Environment
16
14
@@ -62,6 +60,8 @@ This file will go over some quick information about our library, but please refe
62
60
63
61
* Note: A test suite will be developed in future to test the components without the use of external hardware
64
62
63
+
* To run tests, use the command `./gradlew test`
64
+
65
65
### Signing the Contributor License Agreement
66
66
67
67
* While creating a pull request, you’ll be prompted to sign a Contributor License Agreement. Please do so by logging in with your GitHub account.
@@ -96,6 +96,13 @@ This file will go over some quick information about our library, but please refe
96
96
97
97
Thanks for considering a contribution to the Pi4Micronaut library! Your involvement helps make the project better for everyone.
98
98
99
+
## Commands and Gradle Tasks
100
+
101
+
Here are some useful commands and Gradle tasks for working with the Pi4Micronaut library:
102
+
***Build the Project:**`./gradlew build` - Compiles the code and builds the project.
103
+
***Run Tests:**`./gradlew test` - Executes the test suite.
104
+
***Compile AsciiDoc Documentation:**`./gradlew asciidoctor` - Generates the documentation from AsciiDoc files. The output can be found in `pi4micronaut-utils/build/docs/asciidoc`.
105
+
99
106
## How to Create a New Component
100
107
101
108
If it's compatible with a Raspberry Pi, then it should work well with Pi4Micronaut. The following steps should encompass in brief how most components are added to the library; further details can be found on our documentation webpage. Start by creating a new issue to suggest changes.
@@ -122,7 +129,7 @@ All controllers should be kept here: `components/src/main/java/com/opensourcewit
122
129
123
130
### Thoroughly test
124
131
125
-
Contributors should thoroughly test their integrations. Software unit tests should be written in `pi4micronaut-utils/src/test/java/com/opensourcewithslu/(inputdevices or outputdevices)`.
132
+
Contributors should thoroughly test their integrations. Software unit tests should be written in `pi4micronaut-utils/src/test/java/com/opensourcewithslu/(inputdevices or outputdevices)`. They can be run with `./gradlew test`.
126
133
127
134
Hardware testing should also be done. When submitting a pull request, make sure to include how you tested the component, any circuits that you may have used, and how to run any examples you may have created. Instructions for how to conduct hardware testing, including how to send the files over to the Raspberry Pi device, are on our online documentation.
0 commit comments