Merge pull request #1 from ziadoz/master

Merge
This commit is contained in:
Rotimi Ade 2018-05-08 11:37:56 -06:00 committed by GitHub
commit e9b092aa5a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 840 additions and 458 deletions

9
.travis.yml Normal file
View File

@ -0,0 +1,9 @@
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

65
.varci.yml Normal file
View File

@ -0,0 +1,65 @@
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).

50
CODE-OF-CONDUCT.md Normal file
View File

@ -0,0 +1,50 @@
# Contributor Code of Conduct
As contributors and maintainers of this project, and in the interest of
fostering an open and welcoming community, we pledge to respect all people who
contribute through reporting issues, posting feature requests, updating
documentation, submitting pull requests or patches, and other activities.
We are committed to making participation in this project a harassment-free
experience for everyone, regardless of level of experience, gender, gender
identity and expression, sexual orientation, disability, personal appearance,
body size, race, ethnicity, age, religion, or nationality.
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery
* Personal attacks
* Trolling or insulting/derogatory comments
* Public or private harassment
* Publishing other's private information, such as physical or electronic
addresses, without explicit permission
* Other unethical or unprofessional conduct
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.
By adopting this Code of Conduct, project maintainers commit themselves to
fairly and consistently applying these principles to every aspect of managing
this project. Project maintainers who do not follow or enforce the Code of
Conduct may be permanently removed from the project team.
This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community.
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting a project maintainer at awesome-php@josediazgonzalez.com. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. Maintainers are
obligated to maintain confidentiality with regard to the reporter of an
incident.
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 1.3.0, available at
[http://contributor-covenant.org/version/1/3/0/][version]
[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/3/0/

26
COLLABORATING.md Normal file
View File

@ -0,0 +1,26 @@
# Collaboration Guidelines
As a collaborator you are representing the Awesome PHP project to the community. Please adhere to the following guidelines to give everyone the best experience possible:
## Etiquette
Please adhere to the [CODE-OF-CONDUCT](https://github.com/ziadoz/awesome-php/blob/master/CODE-OF-CONDUCT.md) when reviewing suggestions and participating in discussions on the project's Github account.
Always be polite and thank people, even if you dont accept their suggestions.
You are welcome to suggest projects that you are personally involved with, or those of friends, family or colleagues, but you are not allowed to review or merge them yourself, nor should you request that others do so for you. They must be reviewed by a neutral collaborator in their own time.
If you provide feedback on a suggested project please be friendly and constructive.
## Reviewing
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).
## 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.
## Join
If you want to help out please send an email to my Github username [at] gmail [dot] com with the subject “Awesome PHP Collaborator and a link to your Github account and Ill get back to you as soon as I can (I'm notoriously slow, sorry).
Thank you for taking the time to help out with Awesome PHP, your help is appreciated!

View File

@ -1,13 +1,24 @@
# Contribution Guidelines # Contribution Guidelines
Please ensure your pull request adheres to the following 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:
1. Be widely recommended regardless of personal opinion
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 7.0+, Composer-installable, PSR compliant, semantically versioned, unit tested, actively maintained and well documented in English is preferred.
* 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.
* Libraries that are PHP 5.3+, Composer-installable, PSR compliant, tested and documented are preferred. * Enter a meaningful pull request description.
* Please make an individual commit for each suggestion in a pull request. * 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.
* 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 welcome. * New categories, or improvements to the existing categorisation, are always welcome.
* Keep descriptions short and simple. * Please keep descriptions short, simple and unbiased. No buzzwords or marketing jargon.
* 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.

14
LICENSE.md Normal file
View File

@ -0,0 +1,14 @@
DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
Version 2, December 2004
Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
Everyone is permitted to copy and distribute verbatim or modified
copies of this license document, and changing it is allowed as long
as the name is changed.
DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. You just DO WHAT THE FUCK YOU WANT TO.

1007
README.md

File diff suppressed because it is too large Load Diff