encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-04-03 00:34:24 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add notes to contributing docs

Browse Source
This commit is contained in:
Tom Christie 2013-12-09 08:46:18 +00:00
parent e6f6bb5c7e
commit c1be503308
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/topics/contributing.md
View File

@ -164,16 +164,20 @@ If you want to draw attention to a note or warning, use a pair of enclosing line
---
## Third party packages
# Third party packages
New features to REST framework are generally recommended to be implemented as third party libraries that are developed outside of the core framework. Ideally third party libraries should be properly documented and packaged, and made available on PyPI.
## Getting started
If you have some functionality that you would like to implement as a third party package it's worth contacting the [discussion group][google-group] as others may be willing to get involved. We strongly encourage third party package development and will always try to prioritize time spent helping their development, documentation and packaging.
Once your package is decently documented and available on PyPI open a pull request or issue, and we'll add a link to it from the main documentation.
We recommend the [`django-reusable-app`][django-reusable-app] template as a good resource for getting up and running with implementing a third party Django package.
## Linking to your package
Once your package is decently documented and available on PyPI open a pull request or issue, and we'll add a link to it from the main REST framework documentation.
[cite]: http://www.w3.org/People/Berners-Lee/FAQ.html
[code-of-conduct]: https://www.djangoproject.com/conduct/
[google-group]: https://groups.google.com/forum/?fromgroups#!forum/django-rest-framework