Skip to content

Commit 3a5a6c1

Browse files
SinaSeylaniSinaSeylani
authored
Merge pull request #78 from passageidentity/PSG-4888
PSG-4888
2 parents 2d0b690 + 5a3fde3 commit 3a5a6c1

5 files changed

+272
-0
lines changed

‎.github/PULL_REQUEST_TEMPLATE.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Pull Request Template
2+
3+
## What's New?
4+
5+
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.
6+
7+
8+
## Screenshots (if appropriate):
9+
10+
Please attach any screenshots that would help illustrate the changes.
11+
12+
13+
## Type of change
14+
15+
- [ ] Bug fix (non-breaking change which fixes an issue)
16+
- [ ] New feature (non-breaking change which adds functionality)
17+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
18+
- [ ] Documentation update
19+
20+
## Checklist:
21+
22+
- [ ] My code follows the style guidelines of this project
23+
- [ ] I have performed a self-review of my own code
24+
- [ ] I have manually tested my code thoroughly
25+
- [ ] I have added/updated inline documentation for public facing interfaces if relevant
26+
- [ ] My changes generate no new warnings
27+
- [ ] I have added tests that prove my fix is effective or that my feature works
28+
- [ ] New and existing integration and unit tests pass locally with my changes
29+
- [ ] Any dependent changes have been merged and published in downstream modules
30+
31+
32+
## Jira Ticket
33+
34+
Please add the Jira ticket number and link.
35+
36+
- [ ] Jira Ticket: [PSG-XXXX](https://passage-identity.atlassian.net/browse/PSG-XXXX)
37+
38+
39+
## Additional context
40+
41+
Add any other context or screenshots about the pull request here.

‎CODE_OF_CONDUCT.md

+133
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
2+
# Contributor Covenant Code of Conduct
3+
4+
## Our Pledge
5+
6+
We as members, contributors, and leaders pledge to make participation in our
7+
community a harassment-free experience for everyone, regardless of age, body
8+
size, visible or invisible disability, ethnicity, sex characteristics, gender
9+
identity and expression, level of experience, education, socio-economic status,
10+
nationality, personal appearance, race, caste, color, religion, or sexual
11+
identity and orientation.
12+
13+
We pledge to act and interact in ways that contribute to an open, welcoming,
14+
diverse, inclusive, and healthy community.
15+
16+
## Our Standards
17+
18+
Examples of behavior that contributes to a positive environment for our
19+
community include:
20+
21+
* Demonstrating empathy and kindness toward other people
22+
* Being respectful of differing opinions, viewpoints, and experiences
23+
* Giving and gracefully accepting constructive feedback
24+
* Accepting responsibility and apologizing to those affected by our mistakes,
25+
and learning from the experience
26+
* Focusing on what is best not just for us as individuals, but for the overall
27+
community
28+
29+
Examples of unacceptable behavior include:
30+
31+
* The use of sexualized language or imagery, and sexual attention or advances of
32+
any kind
33+
* Trolling, insulting or derogatory comments, and personal or political attacks
34+
* Public or private harassment
35+
* Publishing others' private information, such as a physical or email address,
36+
without their explicit permission
37+
* Other conduct which could reasonably be considered inappropriate in a
38+
professional setting
39+
40+
## Enforcement Responsibilities
41+
42+
Community leaders are responsible for clarifying and enforcing our standards of
43+
acceptable behavior and will take appropriate and fair corrective action in
44+
response to any behavior that they deem inappropriate, threatening, offensive,
45+
or harmful.
46+
47+
Community leaders have the right and responsibility to remove, edit, or reject
48+
comments, commits, code, wiki edits, issues, and other contributions that are
49+
not aligned to this Code of Conduct, and will communicate reasons for moderation
50+
decisions when appropriate.
51+
52+
## Scope
53+
54+
This Code of Conduct applies within all community spaces, and also applies when
55+
an individual is officially representing the community in public spaces.
56+
Examples of representing our community include using an official email address,
57+
posting via an official social media account, or acting as an appointed
58+
representative at an online or offline event.
59+
60+
## Enforcement
61+
62+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
63+
reported to the community leaders responsible for enforcement at
64+
[email protected].
65+
All complaints will be reviewed and investigated promptly and fairly.
66+
67+
All community leaders are obligated to respect the privacy and security of the
68+
reporter of any incident.
69+
70+
## Enforcement Guidelines
71+
72+
Community leaders will follow these Community Impact Guidelines in determining
73+
the consequences for any action they deem in violation of this Code of Conduct:
74+
75+
### 1. Correction
76+
77+
**Community Impact**: Use of inappropriate language or other behavior deemed
78+
unprofessional or unwelcome in the community.
79+
80+
**Consequence**: A private, written warning from community leaders, providing
81+
clarity around the nature of the violation and an explanation of why the
82+
behavior was inappropriate. A public apology may be requested.
83+
84+
### 2. Warning
85+
86+
**Community Impact**: A violation through a single incident or series of
87+
actions.
88+
89+
**Consequence**: A warning with consequences for continued behavior. No
90+
interaction with the people involved, including unsolicited interaction with
91+
those enforcing the Code of Conduct, for a specified period of time. This
92+
includes avoiding interactions in community spaces as well as external channels
93+
like social media. Violating these terms may lead to a temporary or permanent
94+
ban.
95+
96+
### 3. Temporary Ban
97+
98+
**Community Impact**: A serious violation of community standards, including
99+
sustained inappropriate behavior.
100+
101+
**Consequence**: A temporary ban from any sort of interaction or public
102+
communication with the community for a specified period of time. No public or
103+
private interaction with the people involved, including unsolicited interaction
104+
with those enforcing the Code of Conduct, is allowed during this period.
105+
Violating these terms may lead to a permanent ban.
106+
107+
### 4. Permanent Ban
108+
109+
**Community Impact**: Demonstrating a pattern of violation of community
110+
standards, including sustained inappropriate behavior, harassment of an
111+
individual, or aggression toward or disparagement of classes of individuals.
112+
113+
**Consequence**: A permanent ban from any sort of public interaction within the
114+
community.
115+
116+
## Attribution
117+
118+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
119+
version 2.1, available at
120+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
121+
122+
Community Impact Guidelines were inspired by
123+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
124+
125+
For answers to common questions about this code of conduct, see the FAQ at
126+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
127+
[https://www.contributor-covenant.org/translations][translations].
128+
129+
[homepage]: https://www.contributor-covenant.org
130+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
131+
[Mozilla CoC]: https://github.com/mozilla/diversity
132+
[FAQ]: https://www.contributor-covenant.org/faq
133+
[translations]: https://www.contributor-covenant.org/translations

‎CONTRIBUTING.md

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Contributing to Passage Flutter
2+
3+
Thank you for considering contributing to Passage Flutter! Here are some guidelines and instructions to help you get started.
4+
5+
## Table of Contents
6+
7+
1. [Code of Conduct](#code-of-conduct)
8+
2. [Getting Started](#getting-started)
9+
3. [Code Style](#code-style)
10+
4. [Code Generation](#code-generation)
11+
5. [Testing](#testing)
12+
6. [Submitting Changes](#submitting-changes)
13+
7. [Community](#community)
14+
15+
## Code of Conduct
16+
17+
Please read our [Code of Conduct](CODE-OF-CONDUCT.md) to understand the behavior we expect from all contributors.
18+
19+
## Getting Started
20+
21+
1. Fork the repository and clone your fork.
22+
2. Create a new branch for your changes: `git checkout -b my-feature-branch`.
23+
3. Install the necessary dependencies.
24+
25+
## Code Style
26+
27+
Please follow these guidelines to ensure a consistent code style:
28+
29+
- Use FlutterLinkt to enforce Flutter style and conventions.
30+
- Write clear, concise commit messages.
31+
- Comment your code, especially complex or non-obvious sections.
32+
33+
## Submitting Changes
34+
35+
1. Ensure all tests pass and there are no linting errors.
36+
2. Commit your changes to your branch with a clear commit message.
37+
3. Push your branch to your forked repository: `git push origin my-feature-branch`.
38+
4. Create a pull request against the `main` repository.
39+
5. Ensure your pull request includes:
40+
- A reference to the related Jira ticket (internal use only).
41+
- A detailed description of the changes.
42+
- Any additional context or screenshots.
43+
44+
## Community
45+
46+
- Join our discussions on [Discord](https://discord.com/invite/445QpyEDXh) to ask questions and interact with our developers other contributors.
47+
- Check out the [issue tracker](https://github.com/passageidentity/passage-flutter/issues) for ways to contribute.
48+
49+
Thank you for contributing to [Your Project Name]! Your efforts help make this project better for everyone.

‎ISSUE_TEMPLATE.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Passage Swift Issue Template
2+
3+
## Description
4+
5+
Please describe the issue or feature request in detail.
6+
7+
## Steps to Reproduce (for bugs)
8+
9+
1. Step 1
10+
2. Step 2
11+
3. Step 3
12+
13+
## Expected Behavior
14+
15+
Please describe the behavior you expected.
16+
17+
## Actual Behavior
18+
19+
Please describe what actually happened.
20+
21+
## Possible Solution
22+
23+
(Optional) Suggest a fix or reason for the bug.
24+
25+
## Environment
26+
27+
- Package version:
28+
- Android version:
29+
- Ios Version:
30+
- Web Broswer version:
31+
- Device:
32+
- Additional details:
33+
34+
## Additional Context
35+
36+
Add any other context or screenshots about the issue here.

‎SECURITY.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
The following table lists the versions of the project that are currently supported with security updates:
6+
7+
| Version | Supported |
8+
| ------- | ------------------ |
9+
| 1.x | :white_check_mark: |
10+
11+
## Reporting a Vulnerability
12+
13+
Please report security vulnerabilities to [[email protected]](mailto:[email protected]). You will receive a response within 48 hours.

0 commit comments

Comments
 (0)