OSS project template

CODEOWNERS

@@ -0,0 +1 @@
+@gitsino

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,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).

README.md

@@ -8,12 +8,10 @@
     <img src="./Locker-github.jpg" width="700" max-width="50%" alt="Locker"/>
 </p>
 
-
+## Description
 
 Lightweight library for handling sensitive data (`String` type) in Keychain using iOS Biometric features.
 
-## Features
-
   * Save data in Keychain.
   * Fetch data from Keychain with Biometric ID.
   * Delete data from Keychain.
@@ -23,11 +21,23 @@ Lightweight library for handling sensitive data (`String` type) in Keychain usin
   * Detect and supports Simulator.
   * Update the supported devices list without updating the library
 
+Locker does not collect any user data. We have provided a [privacy manifest](https://github.com/infinum/Locker/blob/master/Sources/Locker/SupportingFiles/PrivacyInfo.xcprivacy) file that can be included in your app.
+
+## Table of contents
+
+* [Requirements](#requirements)
+* [Getting started](#getting-started)
+* [Usage](#usage)
+* [Contributing](#contributing)
+* [License](#license)
+* [Credits](#credits)
+
+
 ## Requirements
 
 - iOS 10.0 +
 
-## Installation
+## Getting started
 
 Locker supports CocoaPods, Swift Package Manager and Carthage.
 
@@ -190,11 +200,46 @@ if biometrySettingsChanged && usingBiometry {
 #### 8. There is a local JSON file that contains every iPhone and iPad model which has FaceID or TouchID. That way we can check if the user's device can use FaceID or TouchID. If you want to allow the JSON file to sync itself with a server, you can set `enableDeviceListSync` to `true`.
 `enableDeviceListSync` when enabled, if the device is not present on the local list, it syncs the list with a list from the server and writes it down to the local JSON file.
 
-## Privacy
-
-Locker does not collect any user data. We have provided a [privacy manifest](https://github.com/infinum/Locker/blob/master/Sources/Locker/SupportingFiles/PrivacyInfo.xcprivacy) file that can be included in your app.
 
 ## Contributing
 
 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](https://github.com/infinum/Locker/blob/master/LICENSE).
 
+## License
+
+```text
+MIT License
+
+Copyright (c) 2024 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.
+```
+
+## Credits
+
+Maintained and sponsored by [Infinum](https://infinum.com).
+
+<div align="center">
+    <a href='https://infinum.com'>
+    <picture>
+        <source srcset="https://assets.infinum.com/brand/logo/static/white.svg" media="(prefers-color-scheme: dark)">
+        <img src="https://assets.infinum.com/brand/logo/static/default.svg">
+    </picture>
+    </a>
+</div>

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.