Merge pull request #78 from passageidentity/PSG-4888

PSG-4888

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,41 @@
+# Pull Request Template
+
+## What's New?
+
+Please include a summary of the changes and the related feature/issue. Please also include relevant motivation and context. List any dependencies that are required for this change.
+
+
+## Screenshots (if appropriate):
+
+Please attach any screenshots that would help illustrate the changes.
+
+
+## Type of change
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Documentation update
+
+## Checklist:
+
+- [ ] My code follows the style guidelines of this project
+- [ ] I have performed a self-review of my own code
+- [ ] I have manually tested my code thoroughly
+- [ ] I have added/updated inline documentation for public facing interfaces if relevant
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing integration and unit tests pass locally with my changes
+- [ ] Any dependent changes have been merged and published in downstream modules
+
+
+## Jira Ticket
+
+Please add the Jira ticket number and link.
+
+- [ ] Jira Ticket: [PSG-XXXX](https://passage-identity.atlassian.net/browse/PSG-XXXX)
+
+
+## Additional context
+
+Add any other context or screenshots about the pull request here.

CODE_OF_CONDUCT.md

@@ -0,0 +1,133 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders 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, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+hello@passage.id.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md

@@ -0,0 +1,49 @@
+# Contributing to Passage Flutter
+
+Thank you for considering contributing to Passage Flutter! Here are some guidelines and instructions to help you get started.
+
+## Table of Contents
+
+1. [Code of Conduct](#code-of-conduct)
+2. [Getting Started](#getting-started)
+3. [Code Style](#code-style)
+4. [Code Generation](#code-generation)
+5. [Testing](#testing)
+6. [Submitting Changes](#submitting-changes)
+7. [Community](#community)
+
+## Code of Conduct
+
+Please read our [Code of Conduct](CODE-OF-CONDUCT.md) to understand the behavior we expect from all contributors.
+
+## Getting Started
+
+1. Fork the repository and clone your fork.
+2. Create a new branch for your changes: `git checkout -b my-feature-branch`.
+3. Install the necessary dependencies.
+
+## Code Style
+
+Please follow these guidelines to ensure a consistent code style:
+
+- Use FlutterLinkt to enforce Flutter style and conventions.
+- Write clear, concise commit messages.
+- Comment your code, especially complex or non-obvious sections.
+
+## Submitting Changes
+
+1. Ensure all tests pass and there are no linting errors.
+2. Commit your changes to your branch with a clear commit message.
+3. Push your branch to your forked repository: `git push origin my-feature-branch`.
+4. Create a pull request against the `main` repository.
+5. Ensure your pull request includes:
+   - A reference to the related Jira ticket (internal use only).
+   - A detailed description of the changes.
+   - Any additional context or screenshots.
+
+## Community
+
+- Join our discussions on [Discord](https://discord.com/invite/445QpyEDXh) to ask questions and interact with our developers other contributors.
+- Check out the [issue tracker](https://github.com/passageidentity/passage-flutter/issues) for ways to contribute.
+
+Thank you for contributing to [Your Project Name]! Your efforts help make this project better for everyone.

ISSUE_TEMPLATE.md

@@ -0,0 +1,36 @@
+# Passage Swift Issue Template
+
+## Description
+
+Please describe the issue or feature request in detail.
+
+## Steps to Reproduce (for bugs)
+
+1. Step 1
+2. Step 2
+3. Step 3
+
+## Expected Behavior
+
+Please describe the behavior you expected.
+
+## Actual Behavior
+
+Please describe what actually happened.
+
+## Possible Solution
+
+(Optional) Suggest a fix or reason for the bug.
+
+## Environment
+
+- Package version:
+- Android version:
+- Ios Version:
+- Web Broswer version:
+- Device:
+- Additional details:
+
+## Additional Context
+
+Add any other context or screenshots about the issue here.

SECURITY.md

@@ -0,0 +1,13 @@
+# Security Policy
+
+## Supported Versions
+
+The following table lists the versions of the project that are currently supported with security updates:
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 1.x     | :white_check_mark: |
+
+## Reporting a Vulnerability
+
+Please report security vulnerabilities to [security@passage.id](mailto:security@passage.id). You will receive a response within 48 hours.