Skip to content

Commit

Permalink
Add files
Browse files Browse the repository at this point in the history
  • Loading branch information
KC-2001MS committed Aug 6, 2024
1 parent b9b3951 commit a190b7b
Show file tree
Hide file tree
Showing 11 changed files with 446 additions and 8 deletions.
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @KC-2001MS
71 changes: 71 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
name: Bug Report
description: Report a bug in the OnboardingUI framework.
title: "[Bug]: "
labels: ["bug"]
body:
- type: markdown
attributes:
value: >
Thank you for submitting a bug report. This form is for bug reports only.
- type: input
id: summary
attributes:
label: Summary
description: Summarize the bug in one or two sentences.
validations:
required: true
- type: textarea
id: steps
attributes:
label: Reproduction Steps
description: Explain how you were able to get the bug.
validations:
required: true
- type: textarea
id: expected-results
attributes:
label: Expected Results
description: Enter the expected behavior.
validations:
required: true
- type: textarea
id: actual-results
attributes:
label: Actual Results
description: Enter the actual behavior.
validations:
required: true
- type: dropdown
id: operating-system
attributes:
label: What type of OS did the bug occur on?
multiple: true
options:
- iOS
- iPadOS
- macOS
- watchOS
- tvOS
- visionOS
- Other
validations:
required: true
- type: textarea
id: os-version
attributes:
label: Operating System Version
description: What is the version number of the OS on which the bug occurred?
validations:
required: true
- type: input
id: onboardingui-version
attributes:
label: OnboardingUI Version
description: Indicate which version of OnboardingUI you are using.
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: If you have any other information, screenshots, videos, etc. regarding this bug, please add them here.
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Documentation
url: https://iroiro.dev/OnboardingUI/documentation/onboardingui/
about: More information on using OnboardingUI can be found here.
59 changes: 59 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
name: Documentation Issue
description: Report any problems or deficiencies in the documentation.
title: "[Documentation]: "
labels: ["documentation"]
body:
- type: markdown
attributes:
value: >
Thank you for submitting your documentation issue. This form is for documentation issues only.
- type: input
id: summary
attributes:
label: Summary
description: Summarize the issue in one or two sentences.
validations:
required: true
- type: textarea
id: description
attributes:
label: Description
description: Explain in detail what the issue is.
validations:
required: true
- type: dropdown
id: issue-type
attributes:
label: What type of issue is it?
multiple: true
options:
- Spelling
- Grammar
- Inconsistency
- Suggestion
- Error
- Contradiction
- Too much/Too Little
- Outdated
- Other
validations:
required: true
- type: input
id: onboardingui-version
attributes:
label: OnboardingUI Version
description: Indicate which version of OnboardingUI you are using.
validations:
required: true
- type: input
id: doc-location
attributes:
label: Documentation Location
description: Describe the problem in a way that uniquely identifies the location where the problem occurred.
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Add any other context about the issue here.
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_enhancement.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: Feature Enhancement
description: Propose extensions to existing OnboardingUI functionality.
title: "[Feature Enhancement]: "
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: >
Thank you for submitting your feature enhancement. This form is for feature enhancements only.
- type: input
id: summary
attributes:
label: Summary
description: Summarize the enchancement in one or two sentences.
- type: textarea
id: pain-points
attributes:
label: Pain points
description: Explain in detail what pain points you're trying to solve.
validations:
required: true
- type: textarea
id: alts
attributes:
label: Considered Alternatives
description: What alternative solutions did you consider and how did they fall short of your expectations?
- type: dropdown
id: is-enhancement-breaking-change
attributes:
label: Is this a break change or not?
options:
- 'Yes'
- 'No'
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Add any other context about the issue here.
45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: Feature Request
description: Propose the idea of OnboardingUI.
title: "[Feature Request]: "
labels: ["new feature"]
body:
- type: markdown
attributes:
value: >
Thank you for submitting your feature request. This form is for feature requests only.
- type: input
id: summary
attributes:
label: Summary
description: Summarize the feature in one or two sentences.
- type: textarea
id: pain-points
attributes:
label: Pain points
description: Explain in detail what pain points you're trying to solve.
validations:
required: true
- type: textarea
id: alts
attributes:
label: Considered Alternatives
description: What alternative solutions did you consider and how did they fall short of your expectations?
- type: dropdown
id: is-feature-breaking-change
attributes:
label: Is this a break change or not?
options:
- 'Yes'
- 'No'
validations:
required: true
- type: textarea
id: library-examples
attributes:
label: Library Examples
description: Do you have a library with similar functionality to the one you have in mind? If so, please describe it here.
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: Add any other context about the issue here.
4 changes: 2 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
.DS_Store
/.build
/Packages
/*.xcodeproj
xcuserdata/
DerivedData/
.swiftpm/config/registries.json
.swiftpm/configuration/registries.json
.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
.netrc
.vscode
128 changes: 128 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
# 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, 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 e-mail 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
[email protected].
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.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
Loading

0 comments on commit a190b7b

Please sign in to comment.