From 1db09011f3ca4ec262d96e956c5b3a25da014d54 Mon Sep 17 00:00:00 2001 From: Martey Dodoo Date: Thu, 15 Aug 2013 05:13:03 -0400 Subject: [PATCH 1/2] Add link to ReadTheDocs documentation in README. --- README.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.rst b/README.rst index 2d92446f..b0dec6d8 100644 --- a/README.rst +++ b/README.rst @@ -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 From 5a7505bd74af31323a31337116620257dd63592f Mon Sep 17 00:00:00 2001 From: Martey Dodoo Date: Sat, 19 Oct 2013 21:14:20 -0400 Subject: [PATCH 2/2] Add contributor guidelines. See . --- CONTRIBUTING.rst | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 CONTRIBUTING.rst diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 00000000..0e49ac53 --- /dev/null +++ b/CONTRIBUTING.rst @@ -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 +