Skip to content

Commit 4e2ddfb

Browse files
author
Joel Butcher
committed
update docs etc.
1 parent 15975f3 commit 4e2ddfb

File tree

4 files changed

+100
-30
lines changed

4 files changed

+100
-30
lines changed

CODE_OF_CONDUCT.md

Lines changed: 74 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,76 @@
11
# Code of Conduct
22

3-
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.
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at [email protected]. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

CONTRIBUTING.md

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,49 +3,44 @@ Contributing
33

44
Contributions are **welcome** and will be fully **credited**.
55

6-
We accept contributions via Pull Requests on [Github](https://github.com/facebook/php-graph-sdk/pull/new).
6+
We accept contributions via Pull Requests on [Github](https://github.com/joelbutcher/facebook-graph-sdk/pull/new).
77

8-
The current stable major version is v5. The v6 is under active development.
8+
The current stable major version is v6. The v7 is under development.
99

10-
This means any new feature MUST target v6 (`master` branch).
10+
This means any new feature MUST target v7 (`master` branch).
1111

12-
The v5 (`5.x` branch) is maintained only for bug fixes, node/edge updates or documentation improvements.
12+
The v6 (`6.x` branch) is maintained only for bug fixes, node/edge updates or documentation improvements.
1313

1414
## Code of Conduct
1515
The code of conduct is described in [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md)
1616

17-
1817
## Pull Requests
1918

20-
- **Sign the CLA** - For us to accept contributions you will have to first have signed the
21-
[Contributor License Agreement](https://developers.facebook.com/opensource/cla).
22-
2319
- **[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.
20+
- **[PSR-4 Autoloading](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-4-autoloader.md)**
2421

2522
- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
2623

27-
- **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.
24+
- **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.
2825

29-
- **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.
26+
- **Consider our release cycle** - We follow [SemVer](http://semver.org/). Randomly breaking public APIs is not an option.
3027

3128
- **Create topic branches** - Don't ask us to pull from your master branch.
3229

3330
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
3431

35-
- **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.
32+
- **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!
3633

3734
- **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.
3835

3936
- **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.
4037

41-
4238
## Running Tests
4339

4440
``` bash
4541
$ ./vendor/bin/phpunit
4642
```
4743

48-
4944
## Running PHP Code Sniffer
5045

5146
You can install [PHP Code Sniffer](https://github.com/squizlabs/PHP_CodeSniffer) globally with composer.

LICENSE

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,21 @@
1-
Copyright 2017 Facebook, Inc.
1+
The MIT License (MIT)
22

3-
You are hereby granted a non-exclusive, worldwide, royalty-free license to
4-
use, copy, modify, and distribute this software in source code or binary
5-
form for use in connection with the web services and APIs provided by
6-
Facebook.
3+
Copyright (c) Joel Butcher and Facebook, Inc
74

8-
As with any software that integrates with the Facebook platform, your use
9-
of this software is subject to the Facebook Developer Principles and
10-
Policies [http://developers.facebook.com/policy/]. This copyright notice
11-
shall be included in all copies or substantial portions of the software.
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in
13+
all copies or substantial portions of the Software.
1214

1315
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
1416
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
16-
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
18-
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
19-
DEALINGS IN THE SOFTWARE.
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
THE SOFTWARE.

docs/getting_started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ Whether you're developing a website with Facebook login, creating a Facebook Can
44

55
## System requirements
66

7-
- PHP 5.6 or greater
7+
- PHP 7.4 or PHP 8.0 (or greater)
88
- [Composer](https://getcomposer.org/)
99

1010
## Installing the Facebook SDK for PHP
1111

1212
The Facebook SDK for PHP is installed with [Composer](#installing-with-composer-recommended). Simply run the following in the root of your project.
1313

1414
```
15-
composer require facebook/graph-sdk
15+
composer require joelbutcher/facebook-graph-sdk
1616
```
1717

1818
> The Facebook SDK starting adhering to [SemVer](http://semver.org/) with version 5. Previous to version 5, the SDK did not follow SemVer.

0 commit comments

Comments
 (0)