From 4e2ddfbf62d56855da5a9d3851ebf6a28055e074 Mon Sep 17 00:00:00 2001 From: Joel Butcher Date: Sat, 24 Jul 2021 23:36:56 +0100 Subject: [PATCH] update docs etc. --- CODE_OF_CONDUCT.md | 75 ++++++++++++++++++++++++++++++++++++++++- CONTRIBUTING.md | 21 +++++------- LICENSE | 30 +++++++++-------- docs/getting_started.md | 4 +-- 4 files changed, 100 insertions(+), 30 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 0a45f9bd5..f2e7557da 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,3 +1,76 @@ # Code of Conduct -Facebook has adopted a Code of Conduct that we expect project participants to adhere to. Please [read the full text](https://code.facebook.com/codeofconduct) so that you can understand what actions will and will not be tolerated. +## Our Pledge + +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, sex characteristics, gender identity and expression, +level of experience, education, socio-economic status, nationality, personal +appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or + advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +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. + +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. + +## Scope + +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. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at joel@joelbutcher.co.uk. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and 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. + +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. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see +https://www.contributor-covenant.org/faq diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6e913aedf..9e35621a5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,49 +3,44 @@ Contributing Contributions are **welcome** and will be fully **credited**. -We accept contributions via Pull Requests on [Github](https://github.com/facebook/php-graph-sdk/pull/new). +We accept contributions via Pull Requests on [Github](https://github.com/joelbutcher/facebook-graph-sdk/pull/new). -The current stable major version is v5. The v6 is under active development. +The current stable major version is v6. The v7 is under development. -This means any new feature MUST target v6 (`master` branch). +This means any new feature MUST target v7 (`master` branch). -The v5 (`5.x` branch) is maintained only for bug fixes, node/edge updates or documentation improvements. +The v6 (`6.x` branch) is maintained only for bug fixes, node/edge updates or documentation improvements. ## Code of Conduct The code of conduct is described in [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md) - ## Pull Requests -- **Sign the CLA** - For us to accept contributions you will have to first have signed the - [Contributor License Agreement](https://developers.facebook.com/opensource/cla). - - **[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 run [PHP Code Sniffer](#running-php-code-sniffer) as you code. +- **[PSR-4 Autoloading](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-4-autoloader.md)** - **Add tests!** - Your patch won't be accepted if it doesn't have tests. -- **Document any change in behaviour** - Make sure the README and the [documentation](https://github.com/facebook/facebook-php-sdk-v4/tree/master/docs) are kept up-to-date. +- **Document any change in behaviour** - Make sure the README and the [documentation](https://github.com/joelbutcher/facebook-graph-sdk-php-8/tree/master/docs) are kept up-to-date. -- **Consider our release cycle** - As of version 5.0.0, we try to follow [SemVer](http://semver.org/). Randomly breaking public APIs is not an option. +- **Consider our release cycle** - We follow [SemVer](http://semver.org/). Randomly breaking public APIs is not an option. - **Create topic branches** - Don't ask us to pull from your master branch. - **One pull request per feature** - If you want to do more than one thing, send multiple pull requests. -- **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 before submitting. +- **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 before submitting. No "WIP" or "Update Foo.php" commits - PR's will be rejected! - **Ensure tests pass!** - Please [run the tests](#running-tests) before submitting your pull request, and make sure they pass. We won't accept a patch until all tests pass. - **Ensure no coding standards violations** - Please [run PHP Code Sniffer](#running-php-code-sniffer) using the PSR-2 standard before submitting your pull request. A violation will cause the build to fail, so please make sure there are no violations. We can't accept a patch if the build fails. - ## Running Tests ``` bash $ ./vendor/bin/phpunit ``` - ## Running PHP Code Sniffer You can install [PHP Code Sniffer](https://github.com/squizlabs/PHP_CodeSniffer) globally with composer. diff --git a/LICENSE b/LICENSE index 8b93109ab..b58797347 100644 --- a/LICENSE +++ b/LICENSE @@ -1,19 +1,21 @@ -Copyright 2017 Facebook, Inc. +The MIT License (MIT) -You are hereby granted a non-exclusive, worldwide, royalty-free license to -use, copy, modify, and distribute this software in source code or binary -form for use in connection with the web services and APIs provided by -Facebook. +Copyright (c) Joel Butcher and Facebook, Inc -As with any software that integrates with the Facebook platform, your use -of this software is subject to the Facebook Developer Principles and -Policies [http://developers.facebook.com/policy/]. This copyright notice -shall be included in all copies or substantial portions of the software. +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL -THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING -FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER -DEALINGS IN THE SOFTWARE. +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/docs/getting_started.md b/docs/getting_started.md index f900462d8..6e3583d1f 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -4,7 +4,7 @@ Whether you're developing a website with Facebook login, creating a Facebook Can ## System requirements -- PHP 5.6 or greater +- PHP 7.4 or PHP 8.0 (or greater) - [Composer](https://getcomposer.org/) ## Installing the Facebook SDK for PHP @@ -12,7 +12,7 @@ Whether you're developing a website with Facebook login, creating a Facebook Can The Facebook SDK for PHP is installed with [Composer](#installing-with-composer-recommended). Simply run the following in the root of your project. ``` -composer require facebook/graph-sdk +composer require joelbutcher/facebook-graph-sdk ``` > The Facebook SDK starting adhering to [SemVer](http://semver.org/) with version 5. Previous to version 5, the SDK did not follow SemVer.