Merge branch 'master' into addEditorconfigChecker

This commit is contained in:
Max Strübing 2024-03-11 14:31:34 +01:00 committed by GitHub
commit 6f491123d2
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
8 changed files with 449 additions and 447 deletions

10
.editorconfig Normal file
View File

@ -0,0 +1,10 @@
; This file is for unifying the coding style for different editors and IDEs.
; More information at https://editorconfig.org
root = true
[*]
indent_style = space
indent_size = 2
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true

26
.github/workflows/awesomebot.yml vendored Normal file
View File

@ -0,0 +1,26 @@
name: Awesome Bot
on:
push:
branches:
- master
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: ruby/setup-ruby@v1
with:
ruby-version: '2.7'
- name: Install Awesome Bot
run: gem install awesome_bot
- name: Run Awesome Bot
run: awesome_bot README.md --request-delay 1 --allow-dupe --white-list igor.io,symfony,toranproxy.com,vagrantup.com,3v4l.org,voicesoftheelephpant.com,drupal.org,oreilly.com,youtube.com,lumen.laravel.com
- uses: actions/upload-artifact@v1
if: failure()
with:
name: ab-results
path: ab-results-README.md-filtered.json

View File

@ -1,9 +0,0 @@
language: ruby
rvm:
- 2.2
before_script:
- gem install awesome_bot
script:
- awesome_bot README.md --white-list igor.io,symfony,toranproxy.com,vagrantup.com,3v4l.org,voicesoftheelephpant.com
notifications:
email: false

View File

@ -1,65 +0,0 @@
ruleset:
body_link:
name: "Pull requests that add links should also include them in the body"
events: [ pull_request ]
when:
- action = "opened"
- files = ["README.md"]
- deletions = 0
- not (body_links.added contains diff_links.added)
comment: |
This pull request adds the following suggestion:
{{ diff.added.0 }}
broken_link:
name: "Pull request diff contains broken links"
events: [ pull_request ]
when:
- action = "opened"
- count(diff_links.broken) > 0
comment: >
@{{ user.login }}, at least one of the links in the pull request diff was
reported as broken:
- {{ diff_links.broken.0 }}
missing_link:
name: "Suggestions should include a link"
events: [ pull_request ]
when:
- action = "opened"
- files = ["README.md"]
- deletions = 0
- additions = 1
- count(grep("/^\* /", diff.added)) = 1
- count(diff_links.added) != 1
comment: >
@{{ user.login }}, it looks like you have added a new suggestion to the
`README.md` file but haven't linked to the project. Please update the
`README.md` to also link to the project, thanks!
multiple_additions:
name: "Pull request should only suggest one addition at a time"
events: [ pull_request ]
comment: |
@{{ user.login }}, it looks like you are trying to add multiple suggestions in a single pull request.
If so, please split these into multiple pull requests so each item's inclusion in the list can be discussed separately.
when:
- action = "opened"
- files = ["README.md"]
- deletions = 0
- count(grep("/^\* /", diff.added)) > 1
needs_explanation:
name: 'Pull request bodies should have a detailed explanation'
events: [ pull_request ]
label: 'needs: explanation'
when:
- action = "opened"
- length(body) < 25
message: >
@{{ user.login }}, please update the pull request body with a description
of what you are adding or changing (of at least 25 characters).

View File

@ -35,7 +35,7 @@ This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. when an individual is representing the project or its community.
Instances of abusive, harassing, or otherwise unacceptable behavior may be Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting a project maintainer at awesome-php@josediazgonzalez.com. All reported by contacting a project maintainer at ziadoz@gmail.com. All
complaints will be reviewed and investigated and will result in a response that complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. Maintainers are is deemed necessary and appropriate to the circumstances. Maintainers are
obligated to maintain confidentiality with regard to the reporter of an obligated to maintain confidentiality with regard to the reporter of an

View File

@ -13,9 +13,10 @@ If you provide feedback on a suggested project please be friendly and constructi
## Reviewing ## Reviewing
Please work through the following checklist when reviewing a project: Please work through the following checklist when reviewing a project:
- Tag pull requests with the most relevant label(s).
- Validate URLs work correctly and don't point to anything malicious.
- Ensure suggestions adhere to [CONTRIBUTING](https://github.com/ziadoz/awesome-php/blob/master/CONTRIBUTING.md). - Ensure suggestions adhere to [CONTRIBUTING](https://github.com/ziadoz/awesome-php/blob/master/CONTRIBUTING.md).
- Validate URLs work correctly and don't point to anything malicious.
- Two approvals per pull request is preferred, but not required.
- Simple pull requests fixing typos, formatting and broken links can be merged with a single approval.
## Enhancements ## Enhancements
If you have an idea on how to improve the project, please open a ticket for discussion using the `Enhancement` label. Please dont make any broad or sweeping changes without consulting other collaborators first and reaching a consensus. If you have an idea on how to improve the project, please open a ticket for discussion using the `Enhancement` label. Please dont make any broad or sweeping changes without consulting other collaborators first and reaching a consensus.

View File

@ -1,7 +1,7 @@
# Contribution Guidelines # Contribution Guidelines
Unfortunately, not every library, tool or framework can be considered for inclusion. The aim of Awesome PHP is to be a concise list of noteworthy and interesting software written in modern PHP. Therefore, suggested software should: Unfortunately, not every library, tool or framework can be considered for inclusion. The aim of Awesome PHP is to be a concise list of noteworthy and interesting software written in modern PHP. Therefore, suggested software should:
1. Be widely recommended regardless of personal opinion 1. Be widely recommended
2. Well known or discussed within the PHP community 2. Well known or discussed within the PHP community
3. Be unique in its approach or function 3. Be unique in its approach or function
4. Fill a niche gap in the market 4. Fill a niche gap in the market
@ -10,17 +10,18 @@ Self-promotion is frowned upon, so please consider seriously whether your projec
Also, please ensure your pull request adheres to the following guidelines: Also, please ensure your pull request adheres to the following guidelines:
* Software that is PHP 7.0+, Composer-installable, PSR compliant, semantically versioned, unit tested, actively maintained and well documented in English is preferred. * Software that is PHP 8.0+, Composer-installable, PSR compliant, semantically versioned, unit tested, actively maintained and well documented in English.
* Please search previous suggestions before making a new one, as yours may be a duplicate. * Please search previous suggestions before making a new one, as yours may be a duplicate and will be closed.
* Enter a meaningful pull request description. * Enter a meaningful pull request description.
* Please make an individual commit for each suggestion in a separate pull request.
* Put a link to each library in your pull request ticket so it's easier to review. * Put a link to each library in your pull request ticket so it's easier to review.
* Please make an individual commit for each suggestion in a separate pull request.
* Use the following format for libraries: \[LIBRARY\]\(LINK\) - DESCRIPTION. * Use the following format for libraries: \[LIBRARY\]\(LINK\) - DESCRIPTION.
* Prefix duplicate library names with their vendor or namespace followed by a space: Foo\Bar would be Foo Bar. * Prefix duplicate library names with their vendor or namespace followed by a space: Foo\Bar would be Foo Bar.
* New categories, or improvements to the existing categorisation, are always welcome. * New categories, or improvements to the existing categorisation, are always welcome.
* Please keep descriptions short, simple and unbiased. No buzzwords or marketing jargon. * Please keep descriptions short, simple and unbiased. No buzzwords or marketing jargon please.
* End all descriptions with a full stop/period. * End all descriptions with a full stop/period.
* Check your spelling and grammar. * Check your spelling and grammar.
* Make sure your text editor is set to remove trailing whitespace. * Make sure your text editor is set to remove trailing whitespace.
* Your entry has been added alphabetically within the category.
Thank you for your suggestions! Thank you for your suggestions!

628
README.md

File diff suppressed because it is too large Load Diff