Skip to content

Commit

Permalink
Updates README.md, Github config.
Browse files Browse the repository at this point in the history
  • Loading branch information
DarkGhostHunter committed Aug 26, 2022
1 parent b44d3f5 commit 46820ab
Show file tree
Hide file tree
Showing 12 changed files with 51 additions and 56 deletions.
7 changes: 2 additions & 5 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
# Help me support this package

# Let's keep it free and up to date
github: DarkGhostHunter
patreon: PackagesForLaravel
ko_fi: DarkGhostHunter
custom: ['https://www.buymeacoffee.com/darkghosthunter', 'https://paypal.me/darkghosthunter']
custom: "https://paypal.me/darkghosthunter"
34 changes: 18 additions & 16 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
name: Bug Report
description: File a bug report
description: |
File a bug report to be fixed.
Sponsors get priority issues, PRs, fixes and requests. Not a sponsor? [You're a just click away!](https://github.com/sponsors/DarkGhostHunter).
title: "[X.x] What does happen that is considered an error or bug?"
labels: ["bug"]
assignees:
Expand All @@ -9,6 +12,7 @@ body:
attributes:
value: |
Thanks for taking the time to fill out this bug report!
The more detailed this bug report is, the faster it can be reviewed and fixed.
- type: input
id: version-php-os
Expand All @@ -18,6 +22,14 @@ body:
placeholder: 8.1.2 - Ubuntu 22.04 x64
validations:
required: true
- type: input
id: version-db
attributes:
label: Database
description: Exact DB version using this package, if applicable.
placeholder: MySQL 8.0.28
validations:
required: false
- type: input
id: version-laravel
attributes:
Expand All @@ -31,7 +43,7 @@ body:
attributes:
label: Have you done this?
options:
- label: I am willing to share my stack trace and logs
- label: I have checked my logs and I'm sure is a bug in this package.
required: true
- label: I can reproduce this bug in isolation (vanilla Laravel install)
required: true
Expand All @@ -42,7 +54,7 @@ body:
attributes:
label: Expectation
description: Write what you expect to (correctly) happen.
placeholder: When I do this, I expect to this to happen.
placeholder: When I do this, I expect to happen that.
validations:
required: true
- type: textarea
Expand All @@ -57,7 +69,7 @@ body:
id: reproduction
attributes:
label: Reproduction
description: Paste the code to assert in a test, or just comment with the repository with the bug.
description: Paste the code to assert in a test, or just comment with the repository with the bug to download.
render: php
placeholder: |
$test = Laragear::make()->break();
Expand All @@ -71,18 +83,8 @@ body:
id: logs
attributes:
label: Stack trace & logs
description: If you have a stack trace, you can copy it here. You may hide sensible information.
placeholder: This is automatically formatted into code, no need for backticks.
description: If you have a **full** stack trace, you can copy it here. You may hide sensible information.
placeholder: This is automatically formatted into code, no need for ``` backticks.
render: shell
validations:
required: false
- type: dropdown
id: supporter
attributes:
label: Are you a Patreon supporter?
description: Patreon supporters get priority review, fixing and responses. Are you not? [Become one!](https://patreon.com/packagesforlaravel)
options:
- Yes, with my username
- No, don't give priority to this
validations:
required: true
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
24 changes: 11 additions & 13 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
name: Feature request
description: Suggest a feature for this package
description: |
Suggest a feature for this package.
Sponsors get priority issues, PRs, fixes and requests. Not a sponsor? [You're a just click away!](https://github.com/sponsors/DarkGhostHunter).
title: "[X.x] Add this cool feature for this package"
labels: ["enhancement"]
assignees:
Expand All @@ -11,7 +14,7 @@ body:
Thanks for contributing to this package!
New features keep this package fresh and fun for everybody to use.
- type: checkboxes
id: requeriments
id: requirements
attributes:
label: Please check these requirements
options:
Expand All @@ -28,7 +31,12 @@ body:
attributes:
label: Description
description: Describe how the feature works
placeholder: This new feature would accomplish this, and would be cool to integrate it to the package because...
placeholder: |
This new feature would accomplish...
It could be implemented by doing...
And it would be cool because...
validations:
required: true
- type: textarea
Expand All @@ -41,13 +49,3 @@ body:
render: php
validations:
required: true
- type: dropdown
id: supporter
attributes:
label: Are you a Patreon supporter?
description: Patreon supporters get priority review, fixing and responses. Are you not? [Become one!](https://patreon.com/packagesforlaravel)
options:
- Yes, with my username
- No, don't give priority to this
validations:
required: true
11 changes: 4 additions & 7 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,22 @@
<!--
Thanks for contributing to this package! We only accept PR to the latest stable version.
If you're pushing a Feature:
- Title it: "[X.x] This new feature"
- Describe what the new feature enables
- Show a small code snippet of the new feature
- Ensure it doesn't break any feature.
- Ensure it doesn't break backward compatibility.
If you're pushing a Fix:
- Title it: "[X.x] FIX: The bug name"
- Describe how it fixes in a few words.
- Ensure it doesn't break any feature.
- Ensure it doesn't break backward compatibility.
All Pull Requests run with extensive tests for stable and latest versions of PHP and Laravel.
Ensure your tests pass or your PR may be taken down.
If you're a Patreon supporter, this PR will have priority.
Not a Patreon supporter? Become one at https://patreon.com/packagesforlaravel
If you're a Sponsor, this PR will have priority review.
Not a Sponsor? Become one at https://github.com/sponsors/DarkGhostHunter
-->

# Description
Expand All @@ -29,5 +28,3 @@ This feature/fix allows to...
```php
Laragear::sample();
```

<!-- You may delete this section if it's a FIX -->
Binary file removed .github/assets/buymeacoffee.png
Binary file not shown.
Binary file removed .github/assets/ko-fi.png
Binary file not shown.
Binary file removed .github/assets/patreon.png
Binary file not shown.
Binary file removed .github/assets/paypal.png
Binary file not shown.
Binary file added .github/assets/support.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 7 additions & 12 deletions .github/workflows/php.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# yaml-language-server: $schema=https://json.schemastore.org/github-workflow

name: "Tests"
name: Tests

on:
push:
Expand All @@ -21,6 +21,7 @@ jobs:
- name: "Find non-printable ASCII characters"
run: |
! LC_ALL=C.UTF-8 find ./src -type f -name "*.php" -print0 | xargs -0 -- grep -PHn "[^ -~]"
syntax_errors:
name: "1️⃣ Syntax errors"
runs-on: "ubuntu-latest"
Expand All @@ -34,10 +35,8 @@ jobs:
- name: "Checkout code"
uses: "actions/checkout@v3"

- name: "Install dependencies"
uses: "ramsey/composer-install@v2"
with:
dependency-versions: "highest"
- name: "Validate Composer configuration"
run: "composer validate --strict"

- name: "Check source code for syntax errors"
run: "composer exec -- parallel-lint src/"
Expand All @@ -51,6 +50,7 @@ jobs:
strategy:
matrix:
php-version:
- "8.0"
- "8.1"
laravel-constrain:
- "9.*"
Expand Down Expand Up @@ -89,19 +89,14 @@ jobs:
- name: "Set up PHP"
uses: "shivammathur/setup-php@v2"
with:
php-version: "8.1"
tools: "phpstan"
php-version: "latest"

- name: "Checkout code"
uses: "actions/checkout@v3"

- name: "Validate Composer configuration"
run: "composer validate --strict"

- name: "Install dependencies"
uses: "ramsey/composer-install@v2"
with:
dependency-versions: "highest"

- name: "Execute static analysis"
run: "composer exec -- phpstan analyze -l 5 src/"
Expand All @@ -119,7 +114,7 @@ jobs:
- name: "Check exported files"
run: |
EXPECTED="LICENSE.md,README.md,composer.json"
CURRENT="$(git archive HEAD | tar --list --exclude="src" --exclude="src/*" --exclude=".stubs" --exclude=".stubs/*" --exclude="lang" --exclude="lang/*" --exclude="config" --exclude="config/*" --exclude="database" --exclude="database/*" --exclude="resources" --exclude="resources/*" | paste -s -d ",")"
CURRENT="$(git archive HEAD | tar --list --exclude="src" --exclude="src/*" --exclude=".stubs" --exclude=".stubs/*" --exclude="routes" --exclude="routes/*" --exclude="stubs" --exclude="stubs/*" --exclude="lang" --exclude="lang/*" --exclude="config" --exclude="config/*" --exclude="database" --exclude="database/*" --exclude="resources" --exclude="resources/*" | paste -s -d ",")"
echo "CURRENT =${CURRENT}"
echo "EXPECTED=${EXPECTED}"
test "${CURRENT}" == "${EXPECTED}"
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Two Factor
[![Latest Version on Packagist](https://img.shields.io/packagist/v/laragear/two-factor.svg)](https://packagist.org/packages/laragear/two-factor) [![Latest stable test run](https://github.com/Laragear/TwoFactor/workflows/Tests/badge.svg)](https://github.com/Laragear/TwoFactor/actions) [![Codecov coverage](https://codecov.io/gh/Laragear/TwoFactor/branch/1.x/graph/badge.svg?token=BJMBVZNPM8)](https://codecov.io/gh/Laragear/TwoFactor) [![Maintainability](https://api.codeclimate.com/v1/badges/64241e25adb0f55d7ba1/maintainability)](https://codeclimate.com/github/Laragear/TwoFactor/maintainability) [![Sonarcloud Status](https://sonarcloud.io/api/project_badges/measure?project=Laragear_TwoFactor&metric=alert_status)](https://sonarcloud.io/dashboard?id=Laragear_TwoFactor) [![Laravel Octane Compatibility](https://img.shields.io/badge/Laravel%20Octane-Compatible-success?style=flat&logo=laravel)](https://laravel.com/docs/9.x/octane#introduction)
[![Latest Version on Packagist](https://img.shields.io/packagist/v/laragear/two-factor.svg)](https://packagist.org/packages/laragear/two-factor)
[![Latest stable test run](https://github.com/Laragear/TwoFactor/workflows/Tests/badge.svg)](https://github.com/Laragear/TwoFactor/actions)
[![Codecov coverage](https://codecov.io/gh/Laragear/TwoFactor/branch/1.x/graph/badge.svg?token=BJMBVZNPM8)](https://codecov.io/gh/Laragear/TwoFactor)
[![Maintainability](https://api.codeclimate.com/v1/badges/64241e25adb0f55d7ba1/maintainability)](https://codeclimate.com/github/Laragear/TwoFactor/maintainability)
[![Sonarcloud Status](https://sonarcloud.io/api/project_badges/measure?project=Laragear_TwoFactor&metric=alert_status)](https://sonarcloud.io/dashboard?id=Laragear_TwoFactor)
[![Laravel Octane Compatibility](https://img.shields.io/badge/Laravel%20Octane-Compatible-success?style=flat&logo=laravel)](https://laravel.com/docs/9.x/octane#introduction)

On-premises Two-Factor Authentication for all your users out of the box.

Expand All @@ -23,9 +28,9 @@ This package enables TOTP authentication using 6 digits codes. No need for exter

> Want to authenticate users with fingerprints, patterns or biometric data? Check out [Laragear WebAuthn](https://github.com/Laragear/WebAuthn).
## Keep this package free
## Become a sponsor

[![](.github/assets/patreon.png)](https://patreon.com/packagesforlaravel)[![](.github/assets/ko-fi.png)](https://ko-fi.com/DarkGhostHunter)[![](.github/assets/buymeacoffee.png)](https://www.buymeacoffee.com/darkghosthunter)[![](.github/assets/paypal.png)](https://www.paypal.com/paypalme/darkghosthunter)
[![](.github/assets/support.png)](https://github.com/sponsors/DarkGhostHunter)

Your support allows me to keep this package free, up-to-date and maintainable. Alternatively, you can **[spread the word!](http://twitter.com/share?text=I%20am%20using%20this%20cool%20PHP%20package&url=https://github.com%2FLaragear%2FTwoFactor&hashtags=PHP,Laravel)**

Expand Down

0 comments on commit 46820ab

Please sign in to comment.