forked from mobolic/facebook-sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Make it easier to find docs and contribute.
- Loading branch information
Showing
2 changed files
with
40 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
======================================= | ||
Contributing to the Facebook Python SDK | ||
======================================= | ||
|
||
Use Github Pull Requests | ||
------------------------ | ||
|
||
All potential code changes should be submitted as pull requests on Github. A | ||
pull request should only include commits directly applicable to its change | ||
(e.g. a pull request that adds a new feature should include PEP8 changes in an | ||
unrelated area of the code). | ||
|
||
Code Style | ||
---------- | ||
|
||
Code *must* be compliant with `PEP8`_.Use the latest version of `pep8pypi`_ or | ||
`flake8`_ to catch issues. | ||
|
||
Git commit messages should include `a summary and proper line wrapping`_. | ||
|
||
.. _PEP8: http://www.python.org/dev/peps/pep-0008/ | ||
.. _pep8pypi: https://pypi.python.org/pypi/pep8 | ||
.. _flake8: https://pypi.python.org/pypi/flake8 | ||
.. _a summary and proper line wrapping: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html | ||
|
||
Update Tests and Documentation | ||
------------------------------ | ||
|
||
All non-trivial changes should include full test coverage. Please review | ||
the package's documentation to ensure that it is up to date with any changes. | ||
|
||
Questions? | ||
---------- | ||
|
||
Visit the library's `Google Group`_. | ||
|
||
.. _Google Group: https://groups.google.com/group/pythonforfacebook | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters