Issue 54 - Added Contributor License Agreement (#70)

* added draft of Contributer License Agreement for Pi4J

* added draft of Contributer License Agreement for Pi4J

* Configured CLA and added documentation #issue-54

* added contributingToLibrary

* Fixes issue-54

* Fixes issue-54

* Final Fix issue-54

---------

Co-authored-by: ruthvikm <[email protected]>

CLA.md

@@ -0,0 +1,19 @@
+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.
+
+1. Definitions. "You" (or "Your") shall mean the copyright owner or legal entity authorized by the copyright owner that is making this Agreement with Pi4Micronaut. For legal entities, the entity making a Contribution and all other entities that control, are controlled by, or are under common control with that entity are considered to be a single Contributor. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "Contribution" shall mean any original work of authorship, including any modifications or additions to an existing work, that is intentionally submitted by You to Pi4Micronaut, for inclusion in, or documentation of, any of the products owned, sponsored or managed by Pi4Micronaut (the "Work"). For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to Pi4Micronaut, its employees or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, Pi4Micronaut for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by You as "Not a Contribution."
+
+2. Grant of Copyright License. Subject to the terms and conditions of this CLA, You hereby grant to Pi4Micronaut and to recipients of software distributed by Pi4Micronaut a perpetual, worldwide, non- exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute Your Contributions and such derivative works.
+
+3. Grant of Patent License. Subject to the terms and conditions of this CLA, You hereby grant to Pi4Micronaut and to recipients of software distributed by Pi4Micronaut a perpetual, worldwide, non- exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by You that are necessarily infringed by Your Contribution(s) alone or by combination of Your Contribution(s) with the Work to which such Contribution(s) was submitted. If any entity institutes patent litigation against You or any other entity (including a cross-claim or counterclaim in a lawsuit) alleging that your Contribution, or the Work to which you have contributed, constitutes direct or contributory patent infringement, then any patent licenses granted to that entity under this Agreement for that Contribution or Work shall terminate as of the date such litigation is filed.
+
+4. You represent that you are legally entitled to grant the above license. If your employer(s) has rights to intellectual property that you create that includes your Contributions, you represent that you have received permission to make Contributions on behalf of that employer, that your employer has waived such rights for your Contributions to Pi4Micronaut, or that your employer has executed a separate Corporate CLA with Pi4Micronaut.
+
+5. You represent that each of Your Contributions is Your original creation (see section 7 for submissions on behalf of others). You represent that Your Contribution submissions include complete details of any third-party license or other restriction (including, but not limited to, related patents and trademarks) of which you are personally aware and which are associated with any part of Your Contributions.
+
+6. You are not expected to provide support for Your Contributions, except to the extent You desire to provide support. You may provide support for free, for a fee, or not at all. Unless required by applicable law or agreed to in writing, You provide Your Contributions on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON- INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE.
+
+7. Should You wish to submit work that is not Your original creation, You may submit it to Pi4Micronaut separately from any Contribution, identifying the complete details of its source and of any license or other restriction (including, but not limited to, related patents, trademarks, and license agreements) of which you are personally aware, and conspicuously marking the work as "Submitted on behalf of a third-party: [named here]".
+
+8. You agree to notify Pi4Micronaut of any facts or circumstances of which you become aware that would make these representations inaccurate in any respect.

README.md

@@ -13,4 +13,8 @@
 
 - [Micronaut HTTP Client documentation](https://docs.micronaut.io/latest/guide/index.html#httpClient)
 
+## 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/contribute/contributingToLibrary.adoc

@@ -0,0 +1,85 @@
+== Contribute to the Pi4Micronaut Library
+
+1. 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.
+
+2. 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.
+
+3. 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).
+
+4. 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.
+
+5. 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.
+
+6. 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
+
+7. 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.
+
+8. Submit a Pull Request (PR)
+
+** Push your changes to your forked repository.
+Create a pull request from your branch to the main library's main branch.
+** In the PR description, explain your changes, motivations, and any decisions made.
+** Link to any related issues or discussions.
+
+9. 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.
+
+10. 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.
+
+11. 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

@@ -19,6 +19,10 @@ include::Introduction/supportedHardware.adoc[]
 
 include::Introduction/exampleApplications.adoc[]
 
+include::contribute/contributingToLibrary.adoc[]
+
+include::contribute/newComponent.adoc[]
+
 include::adding_creating_App.adoc[]
 
 
@@ -61,43 +65,5 @@ include::components/outputComponents/led.adoc[]
 include::components/outputComponents/rgbLed.adoc[]
 
 include::components/outputComponents/lcdScreen.adoc[]
-
-include::howContribute.adoc[]
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-