Merge pull request #83 from infinum/incorporate-open-source-templated…

…-changes

Incorporate Infinum open source templated changes

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,29 +1,38 @@
 ---
 name: Bug report
 about: Create a report to help us improve
+title: 'Bug report: '
+labels: bug
+assignees: ''
 
 ---
 
-## :writing_hand: Describe the bug
+---
+name: Bug report
+about: Create a report to help us improve
+
+---
+
+## 📖 Description
 <!-- A clear and concise description of what the bug is. -->
 
-## :bomb: Steps to reproduce
+## ℹ️ Environment
+- **Device**: <!-- e.g. Pixel 5 -->
+- **OS**: <!-- e.g. 9.0.0 -->
+- **Library version**: <!-- e.g. 1.3.0). -->
+
+## 💣 Steps to reproduce
 <!-- How we can reproduce the behavior: -->
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
 4. See error
 
-## :wrench: Expected behavior
+## 🔧 Expected behavior
 <!-- A clear and concise description of what you expected to happen. -->
 
-## :camera: Screenshots
+## 📷 Screenshots
 <!-- If applicable, add screenshots to help explain your problem. -->
 
-## :iphone: Tech info
- - Device: <!-- e.g. Pixel 5 -->
- - OS: <!-- e.g. 9.0.0 -->
- - Sentinel version: <!-- e.g. 1.0.1 -->
-
-## :page_facing_up: Additional context
-<!-- Add any other context about the problem here. -->
+## 📄 Additional information
+<!-- Add any other context about the problem here. -->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,20 +1,29 @@
 ---
 name: Feature request
-about: Suggest an idea for this project
+about: Propose a new feature or an idea for this project
+title: 'Feature request: '
+labels: enhancement
+assignees: ''
 
 ---
 
-## :warning: Is your feature request related to a problem? Please describe
-<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
 
-## :bulb: Describe the solution you'd like
-<!-- A clear and concise description of what you want to happen. -->
+## 💡 Feature description
+<!-- 
+    Add a description of what the the feature is, and what problem does it solve.
+    Try to include clear and concise information about the feature you're requesting.
+-->
 
-## :bar_chart: Describe alternatives you've considered
-<!-- A clear and concise description of any alternative solutions or features you've considered. -->
+## ℹ️ Additional information
 
-## :page_facing_up: Additional context
-<!-- Add any other context or screenshots about the feature request here. -->
+<!-- 
+    Add any other information or screenshots about the feature request here. 
+-->
+
+## 🤔 Describe alternatives you've considered
+<!-- 
+    Can you think of alternative approaches to achieve same goal?
+-->
 
 ## :raising_hand: Do you want to develop this feature yourself?
 <!-- Put an `x` symbol into braces of desired choice. -->

.github/PULL_REQUEST_TEMPLATE

@@ -1,20 +1,42 @@
-## :camera: Screenshots
-<!-- Show us what you've changed, we love images. -->
+## Summary
 
-## :page_facing_up: Context
-<!-- Why did you change something? Is there an [issue](https://github.com/infinum/android-sentinel/issues) to link here? Or an external link? -->
+<!--
+    Provide an overview of what this pull request aims to address or achieve.
 
-## :pencil: Changes
-<!-- Which code did you change? How? -->
+    Link any relevant issues that this pull request addresses or resolves, using the format "Fixes #issue_number".
+-->
 
-## :paperclip: Related PR
-<!-- PR that blocks this one, or the ones blocked by this PR -->
+## Changes
 
-## :no_entry_sign: Breaking
-<!-- Is there something breaking the API? Any class or method signature changed? -->
+### Type
 
-## :hammer_and_wrench: How to test
-<!-- Is there a special case to test your changes? -->
+- [ ] **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.
 
-## :stopwatch: Next steps
-<!-- Do we have to plan something else after the merge? -->
+#### Additional information
+
+- [ ] This pull request introduces a **breaking change**.
+
+### Description
+
+<!--
+    Describe the specific changes made in this pull request, including any technical details or architectural decisions.
+
+    If applicable, include additional information like screenshots, logs or other data that demonstrate the changes.
+-->
+
+## 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
+
+<!--
+    Add any additional comments, instructions, or insights about this pull request.
+-->

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 [email protected]. 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.

CONTRIBUTING.md

@@ -0,0 +1,42 @@
+# 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.
+
+- Contributing code improvements or new features
+- Writing, updating, or fixing tests
+- Improving documentation, including inline comments, user manuals, and developer guides
+
+## 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 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
+
+## 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).

README.md

@@ -6,6 +6,8 @@
 
 ![UI](ui.png)
 
+## Description
+
 _Sentinel_ is a simple one screen UI that provides standardised entry point for tools used in
 development and QA alongside device, application and permissions data.  
 It's designed to be easily configured and expanded depending on needs and requirements of developers
@@ -27,6 +29,23 @@ The project is organized in the following modules:
 - `tool-timber` - contains a class wrapper for Timber
 - `sample` - a sample app for testing and developing
 
+
+## Table of contents
+
+* [Requirements](#requirements)
+* [Usage](#usage)
+* [Getting started](#getting-started)
+* [Contributing](#contributing)
+* [License](#license)
+* [Credits](#credits)
+
+## Requirements
+
+This plugin has been written in Kotlin but works both inside Kotlin and Java projects. Minimum
+required API level to use _Sentinel_ is *21* known
+as [Android 5.0, Lollipop](https://www.android.com/versions/lollipop-5-0/).
+_Sentinel_ is built with and for AndroidX projects.
+
 ## Usage
 
 To include _Sentinel_ in your project, you have to add buildscript dependencies in your project
@@ -104,7 +123,7 @@ debugImplementation("com.infinum.sentinel:tool-timber:$sentinelVersion")
 
 Now you can sync your project.
 
-### Getting started
+## Getting started
 
 Create or inject an instance of _Sentinel_ in your Application class and start watching for
 triggers:
@@ -260,7 +279,7 @@ _Plain_ formatter is selected by default, but selecting any other is persisted b
 - `XML`
 - `HTML`
 
-## Crash monitor
+### Crash monitor
 
 _Sentinel_ has a built in default uncaught exception handler and ANR observer. If switched on in
 settings, it will notify both in a form of a notification. Note that from Android 13 you need to give permission 
@@ -281,7 +300,7 @@ Sentinel.setAnrListener { exception ->
 }
 ```
 
-## Bundle monitor
+### Bundle monitor
 
 _Sentinel_ monitors Bundle objects passed around the application mostly for size limit of 500kB,
 thus avoiding _TransactionTooLarge_ exceptions.  
@@ -299,21 +318,19 @@ for a specific screen, you can do so in the _AndroidManifest.xml_ by adding a _m
 </activity>
 ```
 
-## Requirements
+## Contributing
 
-This plugin has been written in Kotlin but works both inside Kotlin and Java projects. Minimum
-required API level to use _Sentinel_ is *21* known
-as [Android 5.0, Lollipop](https://www.android.com/versions/lollipop-5-0/).
-_Sentinel_ is built with and for AndroidX projects.
+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.
 
-## Contributing
+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.
 
-Feedback and code contributions are very much welcome. Just make a pull request with a short
-description of your changes. By making contributions to this project you give permission for your
-code to be used under the same [license](LICENSE). For easier developing a `sample` application with
+For easier developing a `sample` application with
 proper implementations is provided. If you wish to add a new specific dependency wrapper tool,
 create a new module and set it up like the ones already provided. Then create a pull request.
 
+We appreciate your interest and look forward to your contributions.
+
 ## License
 
 ```

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 [email protected]. 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.