2014-12-18 16:49:50 +03:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta http-equiv = "Content-Type" content = "text/html; charset=UTF-8" >
< meta charset = "utf-8" >
2015-05-15 11:19:49 +03:00
< title > Project management - Django REST framework< / title >
2014-12-18 16:49:50 +03:00
< link href = "../../img/favicon.ico" rel = "icon" type = "image/x-icon" >
< link rel = "canonical" href = "http://www.django-rest-framework.org/topics/project-management/" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
< meta name = "description" content = "Django, API, REST, Project management" >
< meta name = "author" content = "Tom Christie" >
<!-- Le styles -->
< link href = "../../css/prettify.css" rel = "stylesheet" >
< link href = "../../css/bootstrap.css" rel = "stylesheet" >
< link href = "../../css/bootstrap-responsive.css" rel = "stylesheet" >
< link href = "../../css/default.css" rel = "stylesheet" >
<!-- Le HTML5 shim, for IE6 - 8 support of HTML5 elements -->
<!-- [if lt IE 9]>
< script src = "http://html5shim.googlecode.com/svn/trunk/html5.js" > < / script >
<![endif]-->
< script type = "text/javascript" >
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-18852272-2']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script');
ga.type = 'text/javascript';
ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0];
s.parentNode.insertBefore(ga, s);
})();
< / script >
< style >
2016-05-26 13:48:39 +03:00
#sidebarInclude img {
margin-bottom: 10px;
}
#sidebarInclude a.promo {
2014-12-18 16:49:50 +03:00
color: black;
2016-05-26 13:48:39 +03:00
}
2014-12-18 16:49:50 +03:00
@media (max-width: 767px) {
div.promo {
display: none;
}
}
< / style >
< / head >
< body onload = "prettyPrint()" class = "-page" >
< div class = "wrapper" >
< div class = "navbar navbar-inverse navbar-fixed-top" >
< div class = "navbar-inner" >
< div class = "container-fluid" >
2017-05-12 19:15:00 +03:00
< a class = "repo-link btn btn-primary btn-small" href = "https://github.com/encode/django-rest-framework/tree/master" > GitHub< / a >
2017-03-09 17:59:14 +03:00
< a class = "repo-link btn btn-inverse btn-small " rel = "prev" href = "../jobs/" >
2014-12-18 16:49:50 +03:00
Next < i class = "icon-arrow-right icon-white" > < / i >
< / a >
2015-06-04 17:37:22 +03:00
< a class = "repo-link btn btn-inverse btn-small " rel = "next" href = "../contributing/" >
2014-12-18 16:49:50 +03:00
< i class = "icon-arrow-left icon-white" > < / i > Previous
< / a >
2015-06-04 17:37:22 +03:00
< a id = "search_modal_show" class = "repo-link btn btn-inverse btn-small" href = "#mkdocs_search_modal" data-toggle = "modal" data-target = "#mkdocs_search_modal" > < i class = "icon-search icon-white" > < / i > Search< / a >
2014-12-18 16:49:50 +03:00
< a class = "btn btn-navbar" data-toggle = "collapse" data-target = ".nav-collapse" >
< span class = "icon-bar" > < / span >
< span class = "icon-bar" > < / span >
< span class = "icon-bar" > < / span >
< / a >
< a class = "brand" href = "http://www.django-rest-framework.org" > Django REST framework< / a >
< div class = "nav-collapse collapse" >
<!-- Main navigation -->
< ul class = "nav navbar-nav" >
2015-06-04 17:37:22 +03:00
< li >
< a href = "../.." > Home< / a >
< / li >
2014-12-18 16:49:50 +03:00
< li class = "dropdown" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Tutorial < b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu" >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../tutorial/quickstart/" > Quickstart< / a >
2014-12-18 16:49:50 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../tutorial/1-serialization/" > 1 - Serialization< / a >
2014-12-18 16:49:50 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../tutorial/2-requests-and-responses/" > 2 - Requests and responses< / a >
2014-12-18 16:49:50 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../tutorial/3-class-based-views/" > 3 - Class based views< / a >
2014-12-18 16:49:50 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../tutorial/4-authentication-and-permissions/" > 4 - Authentication and permissions< / a >
2014-12-18 16:49:50 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../tutorial/5-relationships-and-hyperlinked-apis/" > 5 - Relationships and hyperlinked APIs< / a >
2014-12-18 16:49:50 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../tutorial/6-viewsets-and-routers/" > 6 - Viewsets and routers< / a >
2014-12-18 16:49:50 +03:00
< / li >
2016-07-14 15:05:57 +03:00
< li >
< a href = "../../tutorial/7-schemas-and-client-libraries/" > 7 - Schemas and client libraries< / a >
< / li >
2014-12-18 16:49:50 +03:00
< / ul >
< / li >
< li class = "dropdown" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > API Guide < b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu" >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/requests/" > Requests< / a >
2014-12-18 16:49:50 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/responses/" > Responses< / a >
2014-12-18 16:49:50 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/views/" > Views< / a >
2014-12-18 16:49:50 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/generic-views/" > Generic views< / a >
2014-12-18 16:49:50 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/viewsets/" > Viewsets< / a >
2014-12-18 16:49:50 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/routers/" > Routers< / a >
2014-12-18 16:49:50 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/parsers/" > Parsers< / a >
2014-12-18 16:49:50 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/renderers/" > Renderers< / a >
2014-12-18 16:49:50 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/serializers/" > Serializers< / a >
2014-12-18 16:49:50 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/fields/" > Serializer fields< / a >
2014-12-18 16:49:50 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/relations/" > Serializer relations< / a >
2014-12-18 16:49:50 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/validators/" > Validators< / a >
2014-12-18 16:49:50 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/authentication/" > Authentication< / a >
2014-12-18 16:49:50 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/permissions/" > Permissions< / a >
2014-12-18 16:49:50 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/throttling/" > Throttling< / a >
2014-12-18 16:49:50 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/filtering/" > Filtering< / a >
2014-12-18 16:49:50 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/pagination/" > Pagination< / a >
2014-12-18 16:49:50 +03:00
< / li >
2015-03-06 15:05:16 +03:00
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/versioning/" > Versioning< / a >
2015-03-06 15:05:16 +03:00
< / li >
2014-12-18 16:49:50 +03:00
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/content-negotiation/" > Content negotiation< / a >
2014-12-18 16:49:50 +03:00
< / li >
2014-12-18 18:42:42 +03:00
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/metadata/" > Metadata< / a >
2014-12-18 18:42:42 +03:00
< / li >
2016-07-07 11:41:32 +03:00
< li >
< a href = "../../api-guide/schemas/" > Schemas< / a >
< / li >
2014-12-18 16:49:50 +03:00
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/format-suffixes/" > Format suffixes< / a >
2014-12-18 16:49:50 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/reverse/" > Returning URLs< / a >
2014-12-18 16:49:50 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/exceptions/" > Exceptions< / a >
2014-12-18 16:49:50 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/status-codes/" > Status codes< / a >
2014-12-18 16:49:50 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/testing/" > Testing< / a >
2014-12-18 16:49:50 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/settings/" > Settings< / a >
2014-12-18 16:49:50 +03:00
< / li >
< / ul >
< / li >
< li class = "dropdown active" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Topics < b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu" >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../documenting-your-api/" > Documenting your API< / a >
2014-12-18 16:49:50 +03:00
< / li >
2016-07-07 11:41:32 +03:00
< li >
< a href = "../api-clients/" > API Clients< / a >
< / li >
2015-03-06 15:05:16 +03:00
< li >
2015-06-04 17:37:22 +03:00
< a href = "../internationalization/" > Internationalization< / a >
2015-03-06 15:05:16 +03:00
< / li >
2014-12-18 16:49:50 +03:00
< li >
2015-06-04 17:37:22 +03:00
< a href = "../ajax-csrf-cors/" > AJAX, CSRF & CORS< / a >
2014-12-18 16:49:50 +03:00
< / li >
2015-10-28 14:35:39 +03:00
< li >
< a href = "../html-and-forms/" > HTML & Forms< / a >
< / li >
2014-12-18 16:49:50 +03:00
< li >
2015-06-04 17:37:22 +03:00
< a href = "../browser-enhancements/" > Browser Enhancements< / a >
2014-12-18 16:49:50 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../browsable-api/" > The Browsable API< / a >
2014-12-18 16:49:50 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../rest-hypermedia-hateoas/" > REST, Hypermedia & HATEOAS< / a >
2014-12-18 16:49:50 +03:00
< / li >
< li >
2017-02-25 22:59:44 +03:00
< a href = "../third-party-packages/" > Third Party Packages< / a >
< / li >
< li >
< a href = "../tutorials-and-resources/" > Tutorials and Resources< / a >
2014-12-18 16:49:50 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../contributing/" > Contributing to REST framework< / a >
2014-12-18 16:49:50 +03:00
< / li >
< li class = "active" >
2015-06-04 17:37:22 +03:00
< a href = "./" > Project management< / a >
2014-12-18 16:49:50 +03:00
< / li >
2017-03-09 17:59:14 +03:00
< li >
< a href = "../jobs/" > Jobs< / a >
< / li >
2014-12-18 16:49:50 +03:00
< li >
2015-06-04 17:37:22 +03:00
< a href = "../3.0-announcement/" > 3.0 Announcement< / a >
2014-12-18 16:49:50 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../3.1-announcement/" > 3.1 Announcement< / a >
2014-12-18 16:49:50 +03:00
< / li >
2015-08-06 16:31:52 +03:00
< li >
< a href = "../3.2-announcement/" > 3.2 Announcement< / a >
< / li >
2015-10-28 14:35:39 +03:00
< li >
< a href = "../3.3-announcement/" > 3.3 Announcement< / a >
< / li >
2016-07-14 15:05:57 +03:00
< li >
< a href = "../3.4-announcement/" > 3.4 Announcement< / a >
< / li >
2016-10-20 18:31:37 +03:00
< li >
< a href = "../3.5-announcement/" > 3.5 Announcement< / a >
< / li >
2017-03-09 17:59:14 +03:00
< li >
< a href = "../3.6-announcement/" > 3.6 Announcement< / a >
< / li >
2017-10-06 15:06:25 +03:00
< li >
< a href = "../3.7-announcement/" > 3.7 Announcement< / a >
< / li >
2014-12-18 16:49:50 +03:00
< li >
2015-06-04 17:37:22 +03:00
< a href = "../kickstarter-announcement/" > Kickstarter Announcement< / a >
2014-12-18 16:49:50 +03:00
< / li >
2016-05-26 13:48:39 +03:00
< li >
< a href = "../mozilla-grant/" > Mozilla Grant< / a >
< / li >
< li >
< a href = "../funding/" > Funding< / a >
< / li >
2014-12-18 16:49:50 +03:00
< li >
2015-06-04 17:37:22 +03:00
< a href = "../release-notes/" > Release Notes< / a >
2014-12-18 16:49:50 +03:00
< / li >
< / ul >
< / li >
< / ul >
< / div >
<!-- /.nav - collapse -->
< / div >
< / div >
< / div >
< div class = "body-content" >
< div class = "container-fluid" >
<!-- Search Modal -->
2015-06-04 17:37:22 +03:00
< div id = "mkdocs_search_modal" class = "modal hide fade" tabindex = "-1" role = "dialog" aria-labelledby = "myModalLabel" aria-hidden = "true" >
2014-12-18 16:49:50 +03:00
< div class = "modal-header" >
< button type = "button" class = "close" data-dismiss = "modal" aria-hidden = "true" > × < / button >
< h3 id = "myModalLabel" > Documentation search< / h3 >
< / div >
< div class = "modal-body" >
2015-08-06 16:31:52 +03:00
< form role = "form" autocomplete = "off" >
2015-06-04 17:37:22 +03:00
< div class = "form-group" >
< input type = "text" name = "q" class = "form-control" placeholder = "Search..." id = "mkdocs-search-query" >
< / div >
< / form >
< div id = "mkdocs-search-results" > < / div >
2014-12-18 16:49:50 +03:00
< / div >
< div class = "modal-footer" >
< button class = "btn" data-dismiss = "modal" aria-hidden = "true" > Close< / button >
< / div >
< / div >
< div class = "row-fluid" >
< div class = "span3" >
< div id = "table-of-contents" >
< ul class = "nav nav-list side-nav well sidebar-nav-fixed" >
< li class = "main" >
< a href = "#project-management" > Project management< / a >
< / li >
< li >
< a href = "#maintenance-team" > Maintenance team< / a >
< / li >
< li >
< a href = "#release-process" > Release process< / a >
< / li >
2015-03-06 15:05:16 +03:00
< li >
< a href = "#translations" > Translations< / a >
< / li >
< li >
< a href = "#project-requirements" > Project requirements< / a >
< / li >
2014-12-18 16:49:50 +03:00
< li >
< a href = "#project-ownership" > Project ownership< / a >
< / li >
2016-05-26 13:48:39 +03:00
< div class = "promo" >
< hr / >
< div id = "sidebarInclude" >
< / div >
2014-12-18 16:49:50 +03:00
< / ul >
< / div >
< / div >
< div id = "main-content" class = "span9" >
2015-06-04 17:37:22 +03:00
2015-11-04 17:59:23 +03:00
< h1 id = "project-management" > < a class = "toclink" href = "#project-management" > Project management< / a > < / h1 >
2014-12-18 16:49:50 +03:00
< blockquote >
< p > "No one can whistle a symphony; it takes a whole orchestra to play it"< / p >
< p > — Halford E. Luccock< / p >
< / blockquote >
< p > This document outlines our project management processes for REST framework.< / p >
2016-10-14 16:33:49 +03:00
< p > The aim is to ensure that the project has a high
2018-01-15 17:42:44 +03:00
< a href = "https://en.wikipedia.org/wiki/Bus_factor" > "bus factor"< / a > , and can continue to remain well supported for the foreseeable future. Suggestions for improvements to our process are welcome.< / p >
2014-12-18 16:49:50 +03:00
< hr / >
2015-11-04 17:59:23 +03:00
< h2 id = "maintenance-team" > < a class = "toclink" href = "#maintenance-team" > Maintenance team< / a > < / h2 >
2014-12-18 16:49:50 +03:00
< p > We have a quarterly maintenance cycle where new members may join the maintenance team. We currently cap the size of the team at 5 members, and may encourage folks to step out of the team for a cycle to allow new members to participate.< / p >
2015-11-04 17:59:23 +03:00
< h4 id = "current-team" > < a class = "toclink" href = "#current-team" > Current team< / a > < / h4 >
2017-05-12 19:15:00 +03:00
< p > The < a href = "https://github.com/encode/django-rest-framework/issues/2190" > maintenance team for Q4 2015< / a > :< / p >
2014-12-18 16:49:50 +03:00
< ul >
2017-05-12 19:15:00 +03:00
< li > < a href = "https://github.com/encode/" > @tomchristie< / a > < / li >
2014-12-18 16:49:50 +03:00
< li > < a href = "https://github.com/xordoquy/" > @xordoquy< / a > (Release manager.)< / li >
< li > < a href = "https://github.com/carltongibson/" > @carltongibson< / a > < / li >
< li > < a href = "https://github.com/kevin-brown/" > @kevin-brown< / a > < / li >
< li > < a href = "https://github.com/jpadilla/" > @jpadilla< / a > < / li >
< / ul >
2015-11-04 17:59:23 +03:00
< h4 id = "maintenance-cycles" > < a class = "toclink" href = "#maintenance-cycles" > Maintenance cycles< / a > < / h4 >
2014-12-18 16:49:50 +03:00
< p > Each maintenance cycle is initiated by an issue being opened with the < code > Process< / code > label.< / p >
< ul >
< li > To be considered for a maintainer role simply comment against the issue.< / li >
< li > Existing members must explicitly opt-in to the next cycle by check-marking their name.< / li >
< li > The final decision on the incoming team will be made by < code > @tomchristie< / code > .< / li >
< / ul >
< p > Members of the maintenance team will be added as collaborators to the repository.< / p >
< p > The following template should be used for the description of the issue, and serves as the formal process for selecting the team.< / p >
< pre > < code > This issue is for determining the maintenance team for the *** period.
Please see the [Project management](http://www.django-rest-framework.org/topics/project-management/) section of our documentation for more details.
---
#### Renewing existing members.
The following people are the current maintenance team. Please checkmark your name if you wish to continue to have write permission on the repository for the *** period.
- [ ] @***
- [ ] @***
- [ ] @***
- [ ] @***
- [ ] @***
---
#### New members.
If you wish to be considered for this or a future date, please comment against this or subsequent issues.
2015-01-10 12:41:12 +03:00
To modify this process for future maintenance cycles make a pull request to the [project management](http://www.django-rest-framework.org/topics/project-management/) documentation.
2014-12-18 16:49:50 +03:00
< / code > < / pre >
2015-11-04 17:59:23 +03:00
< h4 id = "responsibilities-of-team-members" > < a class = "toclink" href = "#responsibilities-of-team-members" > Responsibilities of team members< / a > < / h4 >
2014-12-18 16:49:50 +03:00
< p > Team members have the following responsibilities.< / p >
< ul >
< li > Close invalid or resolved tickets.< / li >
2015-03-06 15:05:16 +03:00
< li > Add triage labels and milestones to tickets.< / li >
2014-12-18 16:49:50 +03:00
< li > Merge finalized pull requests.< / li >
< li > Build and deploy the documentation, using < code > mkdocs gh-deploy< / code > .< / li >
2015-03-06 15:05:16 +03:00
< li > Build and update the included translation packs.< / li >
2014-12-18 16:49:50 +03:00
< / ul >
< p > Further notes for maintainers:< / p >
< ul >
< li > Code changes should come in the form of a pull request - do not push directly to master.< / li >
< li > Maintainers should typically not merge their own pull requests.< / li >
< li > Each issue/pull request should have exactly one label once triaged.< / li >
2017-05-12 19:15:00 +03:00
< li > Search for un-triaged issues with < a href = "https://github.com/encode/django-rest-framework/issues?q=is%3Aopen+no%3Alabel" > is:open no:label< / a > .< / li >
2014-12-18 16:49:50 +03:00
< / ul >
< p > It should be noted that participating actively in the REST framework project clearly < strong > does not require being part of the maintenance team< / strong > . Almost every import part of issue triage and project improvement can be actively worked on regardless of your collaborator status on the repository.< / p >
< hr / >
2015-11-04 17:59:23 +03:00
< h2 id = "release-process" > < a class = "toclink" href = "#release-process" > Release process< / a > < / h2 >
2014-12-18 16:49:50 +03:00
< p > The release manager is selected on every quarterly maintenance cycle.< / p >
< ul >
< li > The manager should be selected by < code > @tomchristie< / code > .< / li >
< li > The manager will then have the maintainer role added to PyPI package.< / li >
< li > The previous manager will then have the maintainer role removed from the PyPI package.< / li >
< / ul >
< p > Our PyPI releases will be handled by either the current release manager, or by < code > @tomchristie< / code > . Every release should have an open issue tagged with the < code > Release< / code > label and marked against the appropriate milestone.< / p >
< p > The following template should be used for the description of the issue, and serves as a release checklist.< / p >
< pre > < code > Release manager is @***.
Pull request is #***.
2015-06-04 17:37:22 +03:00
During development cycle:
- [ ] Upload the new content to be translated to [transifex](http://www.django-rest-framework.org/topics/project-management/#translations).
2014-12-18 16:49:50 +03:00
Checklist:
2017-05-12 19:15:00 +03:00
- [ ] Create pull request for [release notes](https://github.com/encode/django-rest-framework/blob/master/docs/topics/release-notes.md) based on the [*.*.* milestone](https://github.com/encode/django-rest-framework/milestones/***).
2018-01-15 17:42:44 +03:00
- [ ] Update supported versions:
- [ ] `setup.py` `python_requires` list
- [ ] `setup.py` Python & Django version trove classifiers
- [ ] `README` Python & Django versions
- [ ] `docs` Python & Django versions
2015-06-04 17:37:22 +03:00
- [ ] Update the translations from [transifex](http://www.django-rest-framework.org/topics/project-management/#translations).
2017-05-12 19:15:00 +03:00
- [ ] Ensure the pull request increments the version to `*.*.*` in [`restframework/__init__.py`](https://github.com/encode/django-rest-framework/blob/master/rest_framework/__init__.py).
2014-12-18 16:49:50 +03:00
- [ ] Confirm with @tomchristie that release is finalized and ready to go.
- [ ] Ensure that release date is included in pull request.
- [ ] Merge the release pull request.
- [ ] Push the package to PyPI with `./setup.py publish`.
- [ ] Tag the release, with `git tag -a *.*.* -m 'version *.*.*'; git push --tags`.
- [ ] Deploy the documentation with `mkdocs gh-deploy`.
- [ ] Make a release announcement on the [discussion group](https://groups.google.com/forum/?fromgroups#!forum/django-rest-framework).
- [ ] Make a release announcement on twitter.
- [ ] Close the milestone on GitHub.
2015-01-10 12:41:12 +03:00
To modify this process for future releases make a pull request to the [project management](http://www.django-rest-framework.org/topics/project-management/) documentation.
2014-12-18 16:49:50 +03:00
< / code > < / pre >
< p > When pushing the release to PyPI ensure that your environment has been installed from our development < code > requirement.txt< / code > , so that documentation and PyPI installs are consistently being built against a pinned set of packages.< / p >
< hr / >
2015-11-04 17:59:23 +03:00
< h2 id = "translations" > < a class = "toclink" href = "#translations" > Translations< / a > < / h2 >
2015-03-06 15:05:16 +03:00
< p > The maintenance team are responsible for managing the translation packs include in REST framework. Translating the source strings into multiple languages is managed through the < a href = "https://www.transifex.com/projects/p/django-rest-framework/" > transifex service< / a > .< / p >
2015-11-04 17:59:23 +03:00
< h3 id = "managing-transifex" > < a class = "toclink" href = "#managing-transifex" > Managing Transifex< / a > < / h3 >
2015-03-06 15:05:16 +03:00
< p > The < a href = "https://pypi.python.org/pypi/transifex-client" > official Transifex client< / a > is used to upload and download translations to Transifex. The client is installed using pip:< / p >
< pre > < code > pip install transifex-client
< / code > < / pre >
< p > To use it you'll need a login to Transifex which has a password, and you'll need to have administrative access to the Transifex project. You'll need to create a < code > ~/.transifexrc< / code > file which contains your credentials.< / p >
< pre > < code > [https://www.transifex.com]
username = ***
token = ***
password = ***
hostname = https://www.transifex.com
< / code > < / pre >
2015-11-04 17:59:23 +03:00
< h3 id = "upload-new-source-files" > < a class = "toclink" href = "#upload-new-source-files" > Upload new source files< / a > < / h3 >
2015-03-06 15:05:16 +03:00
< p > When any user visible strings are changed, they should be uploaded to Transifex so that the translators can start to translate them. To do this, just run:< / p >
< pre > < code > # 1. Update the source django.po file, which is the US English version.
cd rest_framework
django-admin.py makemessages -l en_US
# 2. Push the source django.po file to Transifex.
cd ..
tx push -s
< / code > < / pre >
< p > When pushing source files, Transifex will update the source strings of a resource to match those from the new source file.< / p >
< p > Here's how differences between the old and new source files will be handled:< / p >
< ul >
< li > New strings will be added.< / li >
< li > Modified strings will be added as well.< / li >
< li > Strings which do not exist in the new source file will be removed from the database, along with their translations. If that source strings gets re-added later then < a href = "http://docs.transifex.com/guides/tm#let-tm-automatically-populate-translations" > Transifex Translation Memory< / a > will automatically include the translation string.< / li >
< / ul >
2015-11-04 17:59:23 +03:00
< h3 id = "download-translations" > < a class = "toclink" href = "#download-translations" > Download translations< / a > < / h3 >
2015-03-06 15:05:16 +03:00
< p > When a translator has finished translating their work needs to be downloaded from Transifex into the REST framework repository. To do this, run:< / p >
< pre > < code > # 3. Pull the translated django.po files from Transifex.
2016-10-14 16:33:49 +03:00
tx pull -a --minimum-perc 10
2015-03-06 15:05:16 +03:00
cd rest_framework
# 4. Compile the binary .mo files for all supported languages.
django-admin.py compilemessages
< / code > < / pre >
< hr / >
2015-11-04 17:59:23 +03:00
< h2 id = "project-requirements" > < a class = "toclink" href = "#project-requirements" > Project requirements< / a > < / h2 >
2015-03-06 15:05:16 +03:00
< p > All our test requirements are pinned to exact versions, in order to ensure that our test runs are reproducible. We maintain the requirements in the < code > requirements< / code > directory. The requirements files are referenced from the < code > tox.ini< / code > configuration file, ensuring we have a single source of truth for package versions used in testing.< / p >
< p > Package upgrades should generally be treated as isolated pull requests. You can check if there are any packages available at a newer version, by using the < code > pip list --outdated< / code > .< / p >
< hr / >
2015-11-04 17:59:23 +03:00
< h2 id = "project-ownership" > < a class = "toclink" href = "#project-ownership" > Project ownership< / a > < / h2 >
2014-12-18 16:49:50 +03:00
< p > The PyPI package is owned by < code > @tomchristie< / code > . As a backup < code > @j4mie< / code > also has ownership of the package.< / p >
< p > If < code > @tomchristie< / code > ceases to participate in the project then < code > @j4mie< / code > has responsibility for handing over ownership duties.< / p >
2015-11-04 17:59:23 +03:00
< h4 id = "outstanding-management-ownership-issues" > < a class = "toclink" href = "#outstanding-management-ownership-issues" > Outstanding management & ownership issues< / a > < / h4 >
2014-12-18 16:49:50 +03:00
< p > The following issues still need to be addressed:< / p >
< ul >
2017-05-12 19:15:00 +03:00
< li > < a href = "https://github.com/encode/django-rest-framework/issues/2162" > Consider moving the repo into a proper GitHub organization< / a > .< / li >
2014-12-18 16:49:50 +03:00
< li > Ensure < code > @jamie< / code > has back-up access to the < code > django-rest-framework.org< / code > domain setup and admin.< / li >
2018-01-15 17:42:44 +03:00
< li > Document ownership of the < a href = "https://restframework.herokuapp.com/" > live example< / a > API.< / li >
2014-12-18 16:49:50 +03:00
< li > Document ownership of the < a href = "https://groups.google.com/forum/#!forum/django-rest-framework" > mailing list< / a > and IRC channel.< / li >
2015-01-10 12:41:12 +03:00
< li > Document ownership and management of the security mailing list.< / li >
2014-12-18 16:49:50 +03:00
< / ul >
2015-06-04 17:37:22 +03:00
2015-06-23 14:05:53 +03:00
< / div > <!-- /span -->
< / div > <!-- /row -->
< / div > <!-- /.fluid - container -->
< / div > <!-- /.body content -->
2014-12-18 16:49:50 +03:00
< div id = "push" > < / div >
2015-06-23 14:05:53 +03:00
< / div > <!-- /.wrapper -->
2014-12-18 16:49:50 +03:00
< footer class = "span12" >
2015-10-28 14:35:39 +03:00
< p > Documentation built with < a href = "http://www.mkdocs.org/" > MkDocs< / a > .
2014-12-18 16:49:50 +03:00
< / p >
< / footer >
<!-- Le javascript
================================================== -->
<!-- Placed at the end of the document so the pages load faster -->
< script src = "../../js/jquery-1.8.1-min.js" > < / script >
< script src = "../../js/prettify-1.0.js" > < / script >
< script src = "../../js/bootstrap-2.1.1-min.js" > < / script >
2016-05-26 13:48:39 +03:00
< script src = "https://fund.django-rest-framework.org/sidebar_include.js" > < / script >
2015-06-04 17:37:22 +03:00
< script > var base _url = '../..' ; < / script >
< script src = "../../mkdocs/js/require.js" > < / script >
2014-12-18 16:49:50 +03:00
< script src = "../../js/theme.js" > < / script >
< script >
var shiftWindow = function() {
scrollBy(0, -50)
};
2015-06-23 14:05:53 +03:00
2014-12-18 16:49:50 +03:00
if (location.hash) shiftWindow();
window.addEventListener("hashchange", shiftWindow);
$('.dropdown-menu').on('click touchstart', function(event) {
event.stopPropagation();
});
2015-06-23 14:05:53 +03:00
// Dynamically force sidenav/dropdown to no higher than browser window
$('.side-nav, .dropdown-menu').css('max-height', window.innerHeight - 130);
2014-12-18 16:49:50 +03:00
$(function() {
$(window).resize(function() {
2015-06-23 14:05:53 +03:00
$('.side-nav, .dropdown-menu').css('max-height', window.innerHeight - 130);
2014-12-18 16:49:50 +03:00
});
});
< / script >
< / body >
< / html >
