From d501716f6a7a556054a285500d0f9c69f420b236 Mon Sep 17 00:00:00 2001 From: 1998-felix Date: Thu, 24 Aug 2023 14:59:12 +0300 Subject: [PATCH] Add Licence and README Signed-off-by: 1998-felix --- CONTRIBUTING.md | 87 ++++++++++++++++++++++ LICENSE | 191 ++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 31 ++++++++ 3 files changed, 309 insertions(+) create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..39af643 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,87 @@ +# Contributing to Mainflux + +The following is a set of guidelines to contribute to Mainflux and its libraries, which are +hosted on the [Mainflux Organization](https://github.com/mainflux) on GitHub. + +This project adheres to the [Contributor Covenant 1.2](http://contributor-covenant.org/version/1/2/0). +By participating, you are expected to uphold this code. Please report unacceptable behavior to +[abuse@mainflux.com](mailto:abuse@mainflux.com). + +## Reporting issues + +Reporting issues are a great way to contribute to the project. We are perpetually grateful about a well-written, +thorough bug report. + +Before raising a new issue, check [our issue +list](https://github.com/mainflux/docs/issues) to determine if it already contains the +problem that you are facing. + +A good bug report shouldn't leave others needing to chase you for more information. Please be as detailed as possible. The following questions might serve as a template for writing a detailed +report: + +- What were you trying to achieve? +- What are the expected results? +- What are the received results? +- What are the steps to reproduce the issue? +- In what environment did you encounter the issue? + +## Pull requests + +Good pull requests (e.g. patches, improvements, new features) are a fantastic help. They should +remain focused in scope and avoid unrelated commits. + +**Please ask first** before embarking on any significant pull request (e.g. implementing new features, +refactoring code etc.), otherwise you risk spending a lot of time working on something that the +maintainers might not want to merge into the project. + +Please adhere to the coding conventions used throughout the project. If in doubt, consult the +[Effective Go](https://golang.org/doc/effective_go.html) style guide. + +To contribute to the project, [fork](https://help.github.com/articles/fork-a-repo/) it, +clone your fork repository and configure the remotes: + +``` +git clone https://github.com//docs.git +cd docs +git remote add upstream https://github.com/mainflux/docs.git +``` + +If your cloned repository is behind the upstream commits, then get the latest changes from upstream: + +``` +git checkout master +git pull --rebase upstream master +``` + +Create a new topic branch from `master` using the naming convention `MF-[issue-number]` +to help us keep track of your contribution scope: + +``` +git checkout -b MF-[issue-number] +``` + +Commit your changes in logical chunks. When you are ready to commit, make sure +to write a Good Commit Message™. Consult the [Erlang's contributing guide](https://github.com/erlang/otp/wiki/Writing-good-commit-messages) +if you're unsure of what constitutes a Good Commit Message™. Use [interactive rebase](https://help.github.com/articles/about-git-rebase) +to group your commits into logical units of work before making it public. + +Note that every commit you make must be signed. By signing off your work you indicate that you +are accepting the [Developer Certificate of Origin](https://developercertificate.org/). + +Use your real name (sorry, no pseudonyms or anonymous contributions). If you set your `user.name` +and `user.email` git configs, you can sign your commit automatically with `git commit -s`. + +Locally merge (or rebase) the upstream development branch into your topic branch: + +``` +git pull --rebase upstream master +``` + +Push your topic branch up to your fork: + +``` +git push origin MBD-[issue-number] +``` + +[Open a Pull Request](https://help.github.com/articles/using-pull-requests/) with a clear title +and detailed description. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..75ed3cb --- /dev/null +++ b/LICENSE @@ -0,0 +1,191 @@ + + Apache License + Version 2.0, January 2004 + https://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. 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. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor 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, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You 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 the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You 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 such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its 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. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + Copyright 2015-2019 Mainflux + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + https://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/README.md b/README.md index bc60516..07dd682 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,33 @@ # embedded Mainflux Embedded Components + +This repo contains code to connect embedded devices to mainflux. + +## Support +The repo currently supports the following communication protocols: +1. MQTT + +## Contributing + +Thank you for your interest in Mainflux and the desire to contribute! + +1. Take a look at our [open issues](https://github.com/mainflux/embedded/issues). The [good-first-issue](https://github.com/mainflux/embedded/labels/good-first-issue) label is specifically for issues that are great for getting started. +2. Check out the [contribution guide](CONTRIBUTING.md) to learn more about our style and conventions. +3. Make your changes compatible with our workflow. + +## Community + +- [Gitter][gitter] +- [Twitter][twitter] + +## License + +[Apache-2.0](LICENSE) + +[gitter]: https://gitter.im/mainflux/mainflux?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge +[gitter-badge]: https://badges.gitter.im/Join%20Chat.svg +[license]: https://img.shields.io/badge/license-Apache%20v2.0-blue.svg +[blog]: https://medium.com/mainflux-iot-platform +[twitter]: https://twitter.com/mainflux +[docs]: https://docs.mainflux.io +[build]: https://github.com/mainflux/docs/actions/workflows/main.yaml/badge.svg