Skip to content

Commit

Permalink
Make it easier to find docs and contribute.
Browse files Browse the repository at this point in the history
  • Loading branch information
martey committed Oct 20, 2013
2 parents 88da46b + 5a7505b commit 89ae9d7
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 0 deletions.
38 changes: 38 additions & 0 deletions CONTRIBUTING.rst
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

2 changes: 2 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,8 @@ bugtracker`_.
Support & Discussion
====================

Documentation is available at https://facebook-sdk.readthedocs.org/en/latest/.

Have a question? Need help? Visit the library's `Google Group`_.

.. _Google Group: https://groups.google.com/group/pythonforfacebook

0 comments on commit 89ae9d7

Please sign in to comment.