From 89942724263e6c8156c5df52f99356d0cb9e5847 Mon Sep 17 00:00:00 2001 From: lukaknezic Date: Tue, 10 Dec 2024 13:48:24 +0100 Subject: [PATCH] Add OS template --- .github/CODEOWNERS | 5 + .github/ISSUE_TEMPLATE/bug_report.yml | 54 +++++ .github/ISSUE_TEMPLATE/feature_request.yml | 0 .github/pull_request_template.md | 42 ++++ flutter_loggy/CHANGELOG.md | 5 + loggy/CODE_OF_CONDUCT.md | 74 +++++++ loggy/CONTRIBUTING.md | 52 +++++ loggy/LICENSE | 222 +++++++++++++++++++-- loggy/README.md | 42 +++- loggy/SECURITY.md | 19 ++ loggy/SETUP.md | 46 +++++ 11 files changed, 530 insertions(+), 31 deletions(-) create mode 100644 .github/CODEOWNERS create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/pull_request_template.md create mode 100644 loggy/CODE_OF_CONDUCT.md create mode 100644 loggy/CONTRIBUTING.md create mode 100644 loggy/SECURITY.md create mode 100644 loggy/SETUP.md diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..ed03ba7 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,5 @@ +# This is a comment. +# Each line is a file pattern followed by one or more owners. +# Code owners are automatically requested for review when someone opens a pull request that modifies code that they own. +# These owners will be the default owners for everything in the repo. +* @Truba @zenled @lukaknezic \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..72c4abc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,54 @@ +name: Bug report +description: File a bug report. +labels: bug +body: + - type: textarea + id: description + attributes: + label: Description + description: A clear and concise description of what the bug is. + validations: + required: true + - type: textarea + id: environment + attributes: + label: Environment + description: | + An environment information where issue occurred. Try to provide as much information as possible, including: + - device name, model and manufacturer + - operating system version + - software name, version and build number + - additional information (e.g. dependencies, IDE, etc.) + value: | + - Device: + - Operating system: + - Software information: + - Additional information: + validations: + required: true + - type: textarea + id: reproduction-steps + attributes: + label: Reproduction steps + description: Steps to reproduce the behavior. + value: | + 1. + 2. + 3. + ... + validations: + required: true + - type: textarea + id: expected-behavior + attributes: + label: Expected behavior + description: A clear and concise description of what you expected to happen. + validations: + required: true + - type: textarea + id: additional-information + attributes: + label: Additional information + description: Any additional information that might be helpful in solving the issue. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..e69de29 diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..872cc9c --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,42 @@ +## Summary + + + +**Related issue**: + +## Changes + +### Type + +- [ ] **Feature**: This pull request introduces a new feature. +- [ ] **Bug fix**: This pull request fixes a bug. +- [ ] **Refactor**: This pull request refactors existing code. +- [ ] **Documentation**: This pull request updates documentation. +- [ ] **Other**: This pull request makes other changes. + +#### Additional information + +- [ ] This pull request introduces a **breaking change**. + +### Description + + + +## Checklist + +- [ ] I have performed a self-review of my own code. +- [ ] I have tested my changes, including edge cases. +- [ ] I have added necessary tests for the changes introduced (if applicable). +- [ ] I have updated the documentation to reflect my changes (if applicable). + +## Additional notes + + \ No newline at end of file diff --git a/flutter_loggy/CHANGELOG.md b/flutter_loggy/CHANGELOG.md index cc180e2..f1b2634 100644 --- a/flutter_loggy/CHANGELOG.md +++ b/flutter_loggy/CHANGELOG.md @@ -1,3 +1,8 @@ +## [2.0.3+1] - 08.10.2024 + +- Removed rxdart dependency + + ## [2.0.3] - 24.05.2024. - Update dependencies diff --git a/loggy/CODE_OF_CONDUCT.md b/loggy/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..08b413a --- /dev/null +++ b/loggy/CODE_OF_CONDUCT.md @@ -0,0 +1,74 @@ +# Code of conduct + +## Our pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, sex characteristics, gender identity and expression, +level of experience, education, socio-economic status, nationality, personal +appearance, race, religion, or sexual identity and orientation. + +## Our standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or + advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at opensource@infinum.com. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4, +available [here](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html). + +For answers to common questions about this code of conduct, visit +the [FAQ](https://www.contributor-covenant.org/faq) page. \ No newline at end of file diff --git a/loggy/CONTRIBUTING.md b/loggy/CONTRIBUTING.md new file mode 100644 index 0000000..bb716aa --- /dev/null +++ b/loggy/CONTRIBUTING.md @@ -0,0 +1,52 @@ +# Contributing guidelines + +Welcome to our project! We appreciate your interest in helping us improve it. + +## How can I contribute? + +There are multiple ways in which you can help us make this project even better. + +- Reporting bugs or suggesting new features +- Contributing code improvements or new features +- Writing, updating, or fixing tests +- Improving documentation, including inline comments, user manuals, and developer guides + +## Issue reporting + +If you found a bug or have an idea for a new feature, please open an issue. Be sure to include a clear and descriptive title, as well as a detailed description of the bug or feature. + +To avoid duplicate issues, please check if a similar issue has already been created. + +## Making changes + +To make changes to the project, please follow these steps: + +1. Fork the project repository. +2. Create a new branch for your changes, based on the project's main branch. +3. Make your changes. Ensure you've followed the coding style and standards. +4. Test your changes thoroughly, ensuring all existing tests pass and new tests cover your changes where appropriate. +5. Commit your changes with a clear and descriptive commit message. +6. Push your changes to your fork. +7. Create a pull request to the project's main branch. + +Once we check everything, we will merge the changes into the main branch and include it in the next release. + +## Guidelines for pull requests + +When submitting a pull request, please ensure that: + +- Your pull request is concise and well-scoped +- Your code is properly tested +- Your code adheres to the project's coding standards and style guidelines +- Your commit message is clear and descriptive +- Your pull request includes a description of the changes you have made and why you have made them + +Try to avoid creating large pull requests that include multiple unrelated changes. Instead, break them down into smaller, more focused pull requests. This will make it easier for us to review and merge your changes. + +## Code of conduct + +We want to ensure a welcoming environment for everyone. With that in mind, all contributors are expected to follow our [code of conduct](/CODE_OF_CONDUCT.md). + +## License + +By submitting a pull request you agree to release that code under the project's [license](/LICENSE). \ No newline at end of file diff --git a/loggy/LICENSE b/loggy/LICENSE index 72659ed..f49a4e1 100644 --- a/loggy/LICENSE +++ b/loggy/LICENSE @@ -1,21 +1,201 @@ -MIT License - -Copyright (c) 2020 Infinum - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. \ No newline at end of file + Apache License + Version 2.0, January 2004 + http://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 + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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 + + http://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/loggy/README.md b/loggy/README.md index c8f9ce3..c35b116 100644 --- a/loggy/README.md +++ b/loggy/README.md @@ -315,20 +315,42 @@ In IntelliJ/Studio you can collapse the request/response body: Set up this is by going to `Preferences -> Editor -> General -> Console` and under `Fold console lines that contain` add these 4 rules: `║`, `╟`, `╔` and `╚`. ![Settings][settings] -## Features and bugs +## Contributing -Please file feature requests and bugs at the [issue tracker][tracker]. +We believe that the community can help us improve and build better a product. +Please refer to our [contributing guide](CONTRIBUTING.md) to learn about the types of contributions we accept and the process for submitting them. -[tracker]: https://github.com/infinum/floggy/issues -[loggy_image]: https://github.com/infinum/floggy/raw/master/assets/loggy_image.png -[show_body]: https://github.com/infinum/floggy/raw/master/assets/2020-10-28%2010.38.39.gif -[settings]: https://github.com/infinum/floggy/raw/master/assets/screenshot_settings.png +To ensure that our community remains respectful and professional, we defined a [code of conduct](CODE_OF_CONDUCT.md) that we expect all contributors to follow. -

- +We appreciate your interest and look forward to your contributions. + +## License + +```text +Copyright 2024 Infinum + +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 + + http://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. +``` + +## Credits + +Maintained and sponsored by [Infinum](https://infinum.com). + +

+ - -

+ +
\ No newline at end of file diff --git a/loggy/SECURITY.md b/loggy/SECURITY.md new file mode 100644 index 0000000..ecf39d7 --- /dev/null +++ b/loggy/SECURITY.md @@ -0,0 +1,19 @@ +# Security + +## Reporting security issues + +At Infinum we are committed to ensuring the security of our software. If you have discovered a security vulnerability or have concerns regarding the security of our project, we encourage you to report it to us in a responsible manner. + +If you discover a security vulnerability, please report it to us by emailing us at opensource@infinum.com. We will review your report, and if the issue is confirmed, we will work to resolve the issue as soon as possible and coordinate the release of a security patch. + +## Responsible disclosure + +We request that you practice responsible disclosure by allowing us time to investigate and address any reported vulnerabilities before making them public. We believe this approach helps protect our users and provides a better outcome for everyone involved. + +## Preferred languages + +We prefer all communication to be in English. + +## Contributions + +We greatly appreciate your help in keeping Infinum projects secure. Your efforts contribute to the ongoing improvement of our project's security. \ No newline at end of file diff --git a/loggy/SETUP.md b/loggy/SETUP.md new file mode 100644 index 0000000..b3e01fc --- /dev/null +++ b/loggy/SETUP.md @@ -0,0 +1,46 @@ +# Setup instructions + +Before you start using this template, complete the following steps: + +## Required changes + +- [ ] Protect the `main` branch +- [x] Add a short description of the repository +- [x] Add tags for the repository + - [x] `open-source`, + - [x] technology tag (`android`, `ios`, `ruby`, `javascript` etc.), + - [x] other tags that are relevant to the repository +- [x] Create a `.gitignore` file +- [ ] Create workflows +- [x] Update the `README.md` file with the missing information + - [x] Delete the _Setup instructions_ note from the file + - [x] Add the project name + - [x] Add the missing information based on the comments in the file +- [ ] Add code owners to the `.github/CODEOWNERS` file +- [x] Define a changelog strategy[^1] +- [ ] Delete the `SETUP.md` file + +## Optional changes + +The repository files can be changed if the project requires it. + +### Project information + +If your project needs to provide additional information like backward compatibility, system status or similar, include it to the `README.md` or additional file in a clear and informative format (e.g. compatibility matrix, table, timeline, etc.). Also, if there is a need for additional information for contributors, additional security measures or specific license, update and adjust related files. + +### Issue templates + +The same applies to issue and pull request templates, where you can adjust information based on the project requirements or required checks in the list (e.g., testing types, performance information, accessibility, etc.). + +### Changes checklist + +If there is a project-specific need, feel free to update and adjust the following files: + +- [ ] Update the `CODE_OF_CONDUCT.md` file +- [ ] Update the `CONTRIBUTING.md` file +- [ ] Update the `SECURITY.md` file +- [ ] Update the `LICENSE` file +- [ ] Update the pull request template +- [ ] Update issue templates + +[^1]: Define how changes will be documented; e.g. `CHANGELOG.md` file, Releases section in GitHub, usage of additional tools, etc. \ No newline at end of file