Configured CLA and added documentation #issue-54

CLA.md

@@ -1,4 +1,4 @@
-Pi4Micronaut Framework Individual Contributor License Agreement
+Pi4Micronaut Individual Contributor License Agreement
 
 By signing below, you accept and agree to the following terms and conditions for Your present and future Contributions submitted to the Pi4Micronaut project. In return, Pi4Micronaut shall not use Your Contributions in a way that is contrary to the public benefit or inconsistent with the Apache License v. 2.0. Except for the license granted herein to Pi4Micronaut and recipients of software distributed by Pi4Micronaut, You reserve all right, title, and interest in and to Your Contributions.
 

README.md

@@ -13,7 +13,7 @@
 
 - [Micronaut HTTP Client documentation](https://docs.micronaut.io/latest/guide/index.html#httpClient)
 
-## Pi4Micronaut Individual Contributer License Agreement
+## Pi4Micronaut Contributor License Agreement
 
 - [Link to CLA](CLA.md)
 

micronautpi4j-utils/README.md

@@ -14,3 +14,4 @@
 - [Micronaut HTTP Client documentation](https://docs.micronaut.io/latest/guide/index.html#httpClient)
 
 
+

micronautpi4j-utils/src/docs/asciidoc/contributingToLibrary.adoc

@@ -0,0 +1,83 @@
+== Contribute to the Pi4Micronaut Library
+
+*Get Familiar with the Library*
+
+Before making contributions,understand the purpose and functionality of the Pi4Micronaut library. Review the library documentation, any related articles, or tutorials.
+
+*Set Up Your Development Environment*
+
+Fork the library's repository from the GitHub.
+Clone your fork locally.
+Follow setup instructions provided in the repository's README or ADOC files.
+
+*Understand the Contribution Process*
+
+Familiarize yourself with the library's contribution guidelines.
+Understand the community guidelines.
+Find out the preferred method of communication (e.g., issues, mailing list, discord).
+
+*Identify a Way to Contribute*
+
+Bug fixes: Look for open issues tagged as 'bug' or report new ones.
+
+New features: Discuss new ideas before implementing, to gauge interest and get guidance.
+
+Documentation: Contribute to the README, ADOC or other documentation.
+
+Testing: Improve or expand the test suite.
+
+Refactoring: Optimize existing code or improve its readability.
+
+*Making Changes*
+
+Always create a new branch for your changes.
+Follow the library's coding style and standards.
+Write clean, well-documented code.
+Add or update tests for your changes, if necessary.
+Commit frequently with meaningful commit messages.
+
+*Test Your Changes*
+
+Ensure that all tests pass.
+Manually test your changes for unforeseen issues.
+Ensure your changes do not introduce regressions.
+Use your own hardware to test the new component integration.
+
+Note: A test suite will be developed in future to test the components without the use of external hardware
+
+*Signing the Contributor License Agreement*
+
+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.
+
+*Submit a Pull Request (PR)*
+
+Push your changes to your forked repository.
+Create a pull request from your branch to the main library's master or main branch.
+In the PR description, explain your changes, motivations, and any decisions made.
+Link to any related issues or discussions.
+
+*Respond to Feedback*
+
+Maintainers or other contributors might provide feedback.
+Be open to suggestions and make necessary revisions.
+Engage in a constructive dialogue to ensure the quality of the contribution.
+
+*Stay Updated*
+
+Keep your fork synchronized with the main repository to ease future contributions.
+Regularly check for updates or changes in the library's contribution guidelines.
+
+*Engage with the Community*
+
+Attend community meetings or join chat groups.
+Help other contributors or users when you can.
+
+Note: While your contribution is highly valued, there's no guarantee that all pull requests will be merged. It depends on the library's direction, quality of the contribution, and decisions of the maintainers.
+
+Thanks for considering a contribution to the Pi4Micronaut library! Your involvement helps make the project better for everyone.
+
+
+
+
+
+

micronautpi4j-utils/src/docs/asciidoc/index.adoc

@@ -1,4 +1,4 @@
-= Pi4Micronaut Documentation
+image::../../../../Pi4Micronaut_logo.png[]
 :source-highlighter: rouge
 :rouge-style: thankful_eyes
 :stylesheet: style.css
@@ -21,7 +21,6 @@ include::Introduction/exampleApplications.adoc[]
 
 include::adding_creating_App.adoc[]
 
-
 include::usingLibrary.adoc[]
 
 include::components.adoc[]
@@ -62,7 +61,7 @@ include::components/outputComponents/rgbLed.adoc[]
 
 include::components/outputComponents/lcdScreen.adoc[]
 
-include::howContribute.adoc[]
+include::contributingToLibrary.adoc[]