From 8f41caea8e77f20ce1fb0d533086446c51447229 Mon Sep 17 00:00:00 2001 From: "Tomasz K." Date: Mon, 28 Oct 2024 11:58:20 +0100 Subject: [PATCH] Update Documentation --- .github/CODEOWNERS | 1 + .github/CODE_OF_CONDUCT.md | 128 ++++++++++++++++++ .github/CONTRIBUTING.md | 1 + .github/ISSUE_TEMPLATE/config.yml | 5 + .../\360\237\232\200-feature-request.md" | 17 +++ .../\360\237\246\237-bug-report.md" | 41 ++++++ .github/workflows/publish-to-cocoapods.yml | 14 ++ .github/workflows/release-cocoapods.yml | 17 --- .github/workflows/run-tests.yml | 16 +++ 9 files changed, 223 insertions(+), 17 deletions(-) create mode 100644 .github/CODEOWNERS create mode 100644 .github/CODE_OF_CONDUCT.md create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 ".github/ISSUE_TEMPLATE/\360\237\232\200-feature-request.md" create mode 100644 ".github/ISSUE_TEMPLATE/\360\237\246\237-bug-report.md" create mode 100644 .github/workflows/publish-to-cocoapods.yml delete mode 100644 .github/workflows/release-cocoapods.yml create mode 100644 .github/workflows/run-tests.yml diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000000..02e39f6c87 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1 @@ +* @FulcrumOne diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000000..916f081452 --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -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 +team@mijick.com. +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. diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000000..684e27f7d7 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1 @@ +Coming soon... diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..d06b7785f1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: ❓ Help and Support Discord Channel + url: https://discord.com/invite/dT5V7nm5SC + about: Please ask and answer questions here diff --git "a/.github/ISSUE_TEMPLATE/\360\237\232\200-feature-request.md" "b/.github/ISSUE_TEMPLATE/\360\237\232\200-feature-request.md" new file mode 100644 index 0000000000..08dc3663fe --- /dev/null +++ "b/.github/ISSUE_TEMPLATE/\360\237\232\200-feature-request.md" @@ -0,0 +1,17 @@ +--- +name: "\U0001F680 Feature Request" +about: If you have a feature request +title: "[FREQ]" +labels: 'state: inactive, type: feature' +assignees: FulcrumOne + +--- + +## Context +What are you trying to do and how would you want to do it differently? Is it something you currently you cannot do? Is this related to an issue/problem? + +## Alternatives +Can you achieve the same result doing it in an alternative way? Is the alternative considerable? + +## If the feature request is approved, would you be willing to submit a PR? +Yes / No _(Help can be provided if you need assistance submitting a PR)_ diff --git "a/.github/ISSUE_TEMPLATE/\360\237\246\237-bug-report.md" "b/.github/ISSUE_TEMPLATE/\360\237\246\237-bug-report.md" new file mode 100644 index 0000000000..f6783f48fb --- /dev/null +++ "b/.github/ISSUE_TEMPLATE/\360\237\246\237-bug-report.md" @@ -0,0 +1,41 @@ +--- +name: "\U0001F99F Bug Report" +about: If something isn't working +title: "[BUG]" +labels: 'state: inactive, type: bug' +assignees: FulcrumOne, jay-jay-lama + +--- + +## Prerequisites +- [ ] I checked the [documentation](https://github.com/Mijick/Popups/wiki) and found no answer +- [ ] I checked to make sure that this issue has not already been filed + +## Expected Behavior +Please describe the behavior you are expecting + +## Current Behavior +What is the current behavior? + +## Steps to Reproduce +Please provide detailed steps for reproducing the issue. +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +## Code Sample +If you can, please include a code sample that we can use to debug the bug. + +## Screenshots +If applicable, add screenshots to help explain your problem. + +## Context +Please provide any relevant information about your setup. This is important in case the issue is not reproducible except for under certain conditions. + +| Name | Version | +| ------| ---------| +| SDK | e.g. 3.0.0 | +| Xcode | e.g. 14.0 | +| Operating System | e.g. iOS 18.0 | +| Device | e.g. iPhone 14 Pro | diff --git a/.github/workflows/publish-to-cocoapods.yml b/.github/workflows/publish-to-cocoapods.yml new file mode 100644 index 0000000000..d685ca32d5 --- /dev/null +++ b/.github/workflows/publish-to-cocoapods.yml @@ -0,0 +1,14 @@ +name: Publish to Cocoapods +on: + deployment: + workflow_dispatch: +jobs: + build: + runs-on: macos-15 + steps: + - uses: actions/checkout@v4 + - name: Publish to Cocoapods + env: + COCOAPODS_TRUNK_TOKEN: ${{ secrets.COCOAPODS_TRUNK_TOKEN }} + run: | + pod trunk push MijickPopups.podspec diff --git a/.github/workflows/release-cocoapods.yml b/.github/workflows/release-cocoapods.yml deleted file mode 100644 index 61366210b6..0000000000 --- a/.github/workflows/release-cocoapods.yml +++ /dev/null @@ -1,17 +0,0 @@ -name: CI -on: - push: - branches: - - master - workflow_dispatch: - -jobs: - build: - runs-on: macOS-latest - steps: - - uses: actions/checkout@v1 - - name: Publish to CocoaPod register - env: - COCOAPODS_TRUNK_TOKEN: ${{ secrets.COCOAPODS_TRUNK_TOKEN }} - run: | - pod trunk push MijickPopupView.podspec diff --git a/.github/workflows/run-tests.yml b/.github/workflows/run-tests.yml new file mode 100644 index 0000000000..1acb12c0e5 --- /dev/null +++ b/.github/workflows/run-tests.yml @@ -0,0 +1,16 @@ +name: Run Tests +on: + push: + branches: [ "main" ] + pull_request: + branches: [ "main" ] + workflow_dispatch: +jobs: + build: + runs-on: macos-15 + steps: + - uses: actions/checkout@v4 + - name: Build + run: swift build -v + - name: Run tests + run: swift test -v