mirror of
https://github.com/namibia/awesome-php.git
synced 2024-12-22 07:38:56 +00:00
Merge branch 'master' into master
This commit is contained in:
commit
9e2159cfe2
23
.github/workflows/awesomebot.yml
vendored
Normal file
23
.github/workflows/awesomebot.yml
vendored
Normal file
@ -0,0 +1,23 @@
|
||||
name: Awesome Bot
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v1
|
||||
- name: Set up Ruby
|
||||
uses: actions/setup-ruby@v1
|
||||
with:
|
||||
ruby-version: 2.7.x
|
||||
- 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
|
@ -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
|
||||
notifications:
|
||||
email: false
|
65
.varci.yml
65
.varci.yml
@ -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).
|
@ -1,26 +1,27 @@
|
||||
# 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:
|
||||
|
||||
a) Be widely recommended regardless of personal opinion
|
||||
b) Well known or discussed within the PHP community
|
||||
c) Be unique in its approach or function
|
||||
d) Fill a niche gap in the market
|
||||
1. Be widely recommended
|
||||
2. Well known or discussed within the PHP community
|
||||
3. Be unique in its approach or function
|
||||
4. Fill a niche gap in the market
|
||||
|
||||
Self-promotion is frowned upon, so please consider seriously whether your project meets the criteria before opening a pull request, otherwise it may be closed without being reviewed.
|
||||
|
||||
Also, please ensure your pull request adheres to the following guidelines:
|
||||
|
||||
* Software that is PHP 5.5+, Composer-installable, PSR compliant, semantically versioned, united tested and well documented in English is preferred.
|
||||
* Please search previous suggestions before making a new one, as yours may be a duplicate.
|
||||
* 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 and will be closed.
|
||||
* 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.
|
||||
* Please make an individual commit for each suggestion in a separate pull request.
|
||||
* 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.
|
||||
* 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.
|
||||
* Check your spelling and grammar.
|
||||
* 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!
|
||||
|
Loading…
Reference in New Issue
Block a user