From 3d54f56fe6eda8fc2cd8bf3dba1f4e7ca7128cc1 Mon Sep 17 00:00:00 2001 From: Martey Dodoo Date: Sat, 15 Oct 2016 17:50:33 -0400 Subject: [PATCH] Move contributing guidelines to standalone file. I suspect people are not clicking through to the documentation when submitting pull requests. This might help. --- CONTRIBUTING.rst | 33 +++++++++++++++++++++++++++------ docs/support.rst | 30 ------------------------------ 2 files changed, 27 insertions(+), 36 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index d8f110d1..712f5fad 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,8 +1,29 @@ -======================================= -Contributing to the Facebook Python SDK -======================================= +Contributing +============ -See `the "Contributing" section of the package's documentation`_ for details on -submitting pull requests, code style, and more. +Use Github Pull Requests +------------------------ -.. _the "Contributing" section of the package's documentation: https://facebook-sdk.readthedocs.org/en/latest/support.html#contributing +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 not include PEP8 changes in +an unrelated area of the code). + +Code Style +---------- + +Code *must* be compliant with `PEP 8`_. Use the latest version of `pep8`_ or +`flake8`_ to catch issues. + +Git commit messages should include `a summary and proper line wrapping`_. + +.. _PEP 8: https://www.python.org/dev/peps/pep-0008/ +.. _pep8: 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. diff --git a/docs/support.rst b/docs/support.rst index 8d301d9c..449affe9 100644 --- a/docs/support.rst +++ b/docs/support.rst @@ -24,33 +24,3 @@ Security Issues Security issues with the SDK that would adversely affect users if reported publicly should be sent through private email to the project maintainer at martey @ marteydodoo.com (GPG key ID is 0x2cd700988f74c455). - -Contributing -============ - -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 not include PEP8 changes in -an unrelated area of the code). - -Code Style ----------- - -Code *must* be compliant with `PEP 8`_. Use the latest version of `pep8`_ or -`flake8`_ to catch issues. - -Git commit messages should include `a summary and proper line wrapping`_. - -.. _PEP 8: https://www.python.org/dev/peps/pep-0008/ -.. _pep8: 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.