Skip to content

Commit

Permalink
Move contributing guidelines to standalone file.
Browse files Browse the repository at this point in the history
I suspect people are not clicking through to the documentation when
submitting pull requests. This might help.
  • Loading branch information
martey committed Oct 15, 2016
1 parent 1fdcd00 commit 3d54f56
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 36 deletions.
33 changes: 27 additions & 6 deletions 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.
30 changes: 0 additions & 30 deletions docs/support.rst
Expand Up @@ -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.

0 comments on commit 3d54f56

Please sign in to comment.