also looking at this
initialize progress
#1
17 files
+581
-48
Review threads live on the whole diff, not on one commit, so none are shown here - a thread's line means something in the branch's final form, and painting it into an intermediate step would put it on code it is not about.
| @@ -0,0 +1,18 @@ | ||
| 1 | ; This file is for unifying the coding style for different editors and IDEs. | |
| 2 | ; More information at https://editorconfig.org | |
| 3 | ||
| 4 | root = true | |
| 5 | ||
| 6 | [*] | |
| 7 | charset = utf-8 | |
| 8 | indent_size = 4 | |
| 9 | indent_style = space | |
| 10 | end_of_line = lf | |
| 11 | insert_final_newline = true | |
| 12 | trim_trailing_whitespace = true | |
| 13 | ||
| 14 | [*.md] | |
| 15 | trim_trailing_whitespace = false | |
| 16 | ||
| 17 | [*.yml] | |
| 18 | indent_size = 2 | |
| @@ -0,0 +1,11 @@ | ||
| 1 | # Path-based git attributes | |
| 2 | # https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html | |
| 3 | ||
| 4 | # Ignore all test and documentation with "export-ignore". | |
| 5 | /.github export-ignore | |
| 6 | /.gitattributes export-ignore | |
| 7 | /.gitignore export-ignore | |
| 8 | /.styleci.yml export-ignore | |
| 9 | /.scrutinizer.yml export-ignore | |
| 10 | /tests export-ignore | |
| 11 | /.editorconfig export-ignore | |
| @@ -0,0 +1,59 @@ | ||
| 1 | --- | |
| 2 | name: "\U0001F41B Bug Report" | |
| 3 | about: Report a general package issue. | |
| 4 | title: "[BUG]" | |
| 5 | labels: bug | |
| 6 | assignees: chris1904 | |
| 7 | --- | |
| 8 | ||
| 9 | <!-- | |
| 10 | PLEASE READ: FILLING IN THE TEMPLATE IS REQUIRED! | |
| 11 | Issues that do not include enough information might not be picked up. | |
| 12 | Issues that have not been filled in using the issue template will be _closed_. | |
| 13 | ||
| 14 | Have you read laravel-media-recognition's contributing guidelines (https://github.com/meemalabs/laravel-media-recognition/blob/main/CONTRIBUTING.md) | |
| 15 | and Code Of Conduct (https://github.com/meemalabs/laravel-media-recognition/main/CODE_OF_CONDUCT.md)? | |
| 16 | ||
| 17 | By filing an Issue, you are expected to comply with it, including treating everyone with respect. | |
| 18 | ||
| 19 | Please prefix your issue with: [BUG] | |
| 20 | --> | |
| 21 | ||
| 22 | ### Prerequisites | |
| 23 | ||
| 24 | <!-- | |
| 25 | Put an X between the brackets if you have done the following: | |
| 26 | --> | |
| 27 | ||
| 28 | * [ ] Are you using Laravel 6 and above? | |
| 29 | * [ ] Able to reproduce the behavior outside of your code, the problem is isolated to laravel-media-recognition` | |
| 30 | * [ ] Checked that your issue isn't already filed. | |
| 31 | * [ ] Checked if no PR was submitted that fixes this problem. | |
| 32 | ||
| 33 | ### Versions | |
| 34 | ||
| 35 | <!-- Please be as exact and complete as possible when providing version numbers --> | |
| 36 | ||
| 37 | * PHP version: <!-- put your FULL (including patch number) PHP version here --> | |
| 38 | * Laravel version: <!-- put your FULL (including patch number) Laravel version here --> | |
| 39 | * Package version: <!-- put FULL (including patch number) Laravel Text to Speech package version here --> | |
| 40 | ||
| 41 | ### Description | |
| 42 | ||
| 43 | <!-- Describe the issue --> | |
| 44 | ||
| 45 | ### Steps to Reproduce | |
| 46 | ||
| 47 | <!-- How can this issue be reproduced? Provide a reproduction repository to help us reproduce the issue easily. --> | |
| 48 | ||
| 49 | **Expected behavior:** | |
| 50 | ||
| 51 | <!-- What you expect to happen --> | |
| 52 | ||
| 53 | **Actual behavior:** | |
| 54 | ||
| 55 | <!-- What actually happens. Please include screenshots, stack traces and anything that can help us understand the issue. --> | |
| 56 | ||
| 57 | ### Additional Information | |
| 58 | ||
| 59 | Any additional information, configuration or data that might be necessary to reproduce the issue. | |
| @@ -0,0 +1,42 @@ | ||
| 1 | --- | |
| 2 | name: "\U0001F4A1 Ideas" | |
| 3 | about: "If you have a \U0001F525 idea or proposals." | |
| 4 | title: "[IDEA]" | |
| 5 | labels: enhancement | |
| 6 | assignees: chris1904 | |
| 7 | --- | |
| 8 | ||
| 9 | <!-- | |
| 10 | ||
| 11 | PLEASE READ: FILLING IN THE TEMPLATE IS REQUIRED! | |
| 12 | Issues should require enough information. | |
| 13 | ||
| 14 | Have you read meema-client-php's | |
| 15 | contributing guidelines (https://github.com/meemalabs/meema-client-php/blob/main/CONTRIBUTING.md) | |
| 16 | and Code Of Conduct (https://github.com/meemalabs/meema-client-php/main/CODE_OF_CONDUCT.md)? | |
| 17 | By filing an idea, you are expected to comply with it, including treating everyone with respect. | |
| 18 | ||
| 19 | Please prefix your idea with: [IDEA]. | |
| 20 | ||
| 21 | --> | |
| 22 | ||
| 23 | ### Prerequisites | |
| 24 | ||
| 25 | ### Versions | |
| 26 | ||
| 27 | <!-- Please be as exact and complete as possible when providing version numbers --> | |
| 28 | ||
| 29 | * PHP version: <!-- put your FULL PHP version here --> | |
| 30 | * Client version: <!-- put FULL meema-client-php package version here --> | |
| 31 | ||
| 32 | ### Description | |
| 33 | ||
| 34 | <!-- Describe your proposal --> | |
| 35 | ||
| 36 | ### Example | |
| 37 | ||
| 38 | <!-- Show an example of how this proposal will work. --> | |
| 39 | ||
| 40 | ### Additional Information | |
| 41 | ||
| 42 | Any additional information, configuration or data that might be needed to understand the proposal. | |
| @@ -0,0 +1,40 @@ | ||
| 1 | name: Run Tests | |
| 2 | ||
| 3 | on: | |
| 4 | push: | |
| 5 | pull_request: | |
| 6 | ||
| 7 | jobs: | |
| 8 | run-tests: | |
| 9 | runs-on: ubuntu-latest | |
| 10 | strategy: | |
| 11 | fail-fast: false | |
| 12 | matrix: | |
| 13 | php: [7.4, 8.0] | |
| 14 | dependency-version: [prefer-lowest, prefer-stable] | |
| 15 | ||
| 16 | name: P ${{ matrix.php }} - ${{ matrix.dependency-version }} | |
| 17 | ||
| 18 | steps: | |
| 19 | - name: Checkout code | |
| 20 | uses: actions/checkout@v2 | |
| 21 | ||
| 22 | - name: Setup PHP | |
| 23 | uses: shivammathur/setup-php@v2 | |
| 24 | with: | |
| 25 | php-version: ${{ matrix.php }} | |
| 26 | extensions: mbstring, curl | |
| 27 | ||
| 28 | - name: Cache dependencies | |
| 29 | uses: actions/cache@v1 | |
| 30 | with: | |
| 31 | path: ~/.composer/cache/files | |
| 32 | key: dependencies-php-${{ matrix.php }}-composer-${{ hashFiles('composer.json') }} | |
| 33 | ||
| 34 | - name: Install dependencies | |
| 35 | run: | | |
| 36 | composer require "orchestra/testbench:$" --no-interaction --no-update | |
| 37 | composer update --${{ matrix.dependency-version }} --prefer-dist --no-interaction --no-suggest | |
| 38 | ||
| 39 | - name: Execute tests | |
| 40 | run: vendor/bin/pest | |
| @@ -0,0 +1,23 @@ | ||
| 1 | name: Tag Release | |
| 2 | ||
| 3 | on: | |
| 4 | push: | |
| 5 | tags: | |
| 6 | - "*" | |
| 7 | ||
| 8 | jobs: | |
| 9 | tag-release: | |
| 10 | name: "Tagged Release" | |
| 11 | runs-on: ubuntu-latest | |
| 12 | ||
| 13 | steps: | |
| 14 | - name: Checkout | |
| 15 | uses: actions/checkout@v2 | |
| 16 | with: | |
| 17 | fetch-depth: 0 | |
| 18 | ||
| 19 | - name: Create Release | |
| 20 | uses: "marvinpinto/action-automatic-releases@latest" | |
| 21 | with: | |
| 22 | repo_token: "$" | |
| 23 | prerelease: false | |
| @@ -0,0 +1,41 @@ | ||
| 1 | filter: | |
| 2 | paths: [src/*] | |
| 3 | excluded_paths: [tests/*] | |
| 4 | checks: | |
| 5 | php: | |
| 6 | code_rating: true | |
| 7 | remove_extra_empty_lines: true | |
| 8 | remove_php_closing_tag: true | |
| 9 | remove_trailing_whitespace: true | |
| 10 | fix_use_statements: | |
| 11 | remove_unused: true | |
| 12 | preserve_multiple: false | |
| 13 | preserve_blanklines: true | |
| 14 | order_alphabetically: true | |
| 15 | fix_php_opening_tag: true | |
| 16 | fix_linefeed: true | |
| 17 | fix_line_ending: true | |
| 18 | fix_identation_4spaces: true | |
| 19 | fix_doc_comments: true | |
| 20 | tools: | |
| 21 | external_code_coverage: | |
| 22 | timeout: 600 | |
| 23 | runs: 3 | |
| 24 | php_code_coverage: false | |
| 25 | php_code_sniffer: | |
| 26 | config: | |
| 27 | standard: PSR2 | |
| 28 | filter: | |
| 29 | paths: ['src'] | |
| 30 | php_loc: | |
| 31 | enabled: true | |
| 32 | excluded_dirs: [vendor, test] | |
| 33 | php_cpd: | |
| 34 | enabled: true | |
| 35 | excluded_dirs: [vendor, test] | |
| 36 | build: | |
| 37 | nodes: | |
| 38 | analysis: | |
| 39 | tests: | |
| 40 | override: | |
| 41 | - php-scrutinizer-run | |
| @@ -0,0 +1,46 @@ | ||
| 1 | # Contributor Covenant Code of Conduct | |
| 2 | ||
| 3 | ## Our Pledge | |
| 4 | ||
| 5 | In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. | |
| 6 | ||
| 7 | ## Our Standards | |
| 8 | ||
| 9 | Examples of behavior that contributes to creating a positive environment include: | |
| 10 | ||
| 11 | * Using welcoming and inclusive language | |
| 12 | * Being respectful of differing viewpoints and experiences | |
| 13 | * Gracefully accepting constructive criticism | |
| 14 | * Focusing on what is best for the community | |
| 15 | * Showing empathy towards other community members | |
| 16 | ||
| 17 | Examples of unacceptable behavior by participants include: | |
| 18 | ||
| 19 | * The use of sexualized language or imagery and unwelcome sexual attention or advances | |
| 20 | * Trolling, insulting/derogatory comments, and personal or political attacks | |
| 21 | * Public or private harassment | |
| 22 | * Publishing others' private information, such as a physical or electronic address, without explicit permission | |
| 23 | * Other conduct which could reasonably be considered inappropriate in a professional setting | |
| 24 | ||
| 25 | ## Our Responsibilities | |
| 26 | ||
| 27 | Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. | |
| 28 | ||
| 29 | Project maintainers 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, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. | |
| 30 | ||
| 31 | ## Scope | |
| 32 | ||
| 33 | This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. | |
| 34 | ||
| 35 | ## Enforcement | |
| 36 | ||
| 37 | Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at rigel20.kent@gmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. | |
| 38 | ||
| 39 | Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. | |
| 40 | ||
| 41 | ## Attribution | |
| 42 | ||
| 43 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] | |
| 44 | ||
| 45 | [homepage]: http://contributor-covenant.org | |
| 46 | [version]: http://contributor-covenant.org/version/1/4/ | |
| @@ -0,0 +1,55 @@ | ||
| 1 | # Contributing | |
| 2 | ||
| 3 | Contributions are **welcome** and will be fully **credited**. | |
| 4 | ||
| 5 | Please read and understand the contribution guide before creating an issue or pull request. | |
| 6 | ||
| 7 | ## Etiquette | |
| 8 | ||
| 9 | This project is open source, and as such, the maintainers give their free time to build and maintain the source code | |
| 10 | held within. They make the code freely available in the hope that it will be of use to other developers. It would be | |
| 11 | extremely unfair for them to suffer abuse or anger for their hard work. | |
| 12 | ||
| 13 | Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the | |
| 14 | world that developers are civilized and selfless people. | |
| 15 | ||
| 16 | It's the duty of the maintainer to ensure that all submissions to the project are of sufficient | |
| 17 | quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used. | |
| 18 | ||
| 19 | ## Viability | |
| 20 | ||
| 21 | When requesting or submitting new features, first consider whether it might be useful to others. Open | |
| 22 | source projects are used by many developers, who may have entirely different needs to your own. Think about | |
| 23 | whether or not your feature is likely to be used by other users of the project. | |
| 24 | ||
| 25 | ## Procedure | |
| 26 | ||
| 27 | Before filing an issue: | |
| 28 | ||
| 29 | - Attempt to replicate the problem, to ensure that it wasn't a coincidental incident. | |
| 30 | - Check to make sure your feature suggestion isn't already present within the project. | |
| 31 | - Check the pull requests tab to ensure that the bug doesn't have a fix in progress. | |
| 32 | - Check the pull requests tab to ensure that the feature isn't already in progress. | |
| 33 | ||
| 34 | Before submitting a pull request: | |
| 35 | ||
| 36 | - Check the codebase to ensure that your feature doesn't already exist. | |
| 37 | - Check the pull requests to ensure that another person hasn't already submitted the feature or fix. | |
| 38 | ||
| 39 | ## Requirements | |
| 40 | ||
| 41 | If the project maintainer has any additional requirements, you will find them listed here. | |
| 42 | ||
| 43 | - **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](https://pear.php.net/package/PHP_CodeSniffer). | |
| 44 | ||
| 45 | - **Add tests!** - Your patch won't be accepted if it doesn't have tests. | |
| 46 | ||
| 47 | - **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date. | |
| 48 | ||
| 49 | - **Consider our release cycle** - We try to follow [SemVer v2.0.0](https://semver.org/). Randomly breaking public APIs is not an option. | |
| 50 | ||
| 51 | - **One pull request per feature** - If you want to do more than one thing, send multiple pull requests. | |
| 52 | ||
| 53 | - **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](https://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting. | |
| 54 | ||
| 55 | **Happy coding**! | |