-
Notifications
You must be signed in to change notification settings - Fork 83
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
provide a .md template alongside the .rst one #94
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -295,21 +295,25 @@ DEP format | |||||
|
||||||
To save everyone time reading DEPs, they need to follow a common format | ||||||
and outline; this section describes that format. In most cases, it's probably | ||||||
easiest to start with copying the provided `DEP template <../template.rst>`_, | ||||||
easiest to start with copying one of the provided DEP templates | ||||||
(`rst template <../template.rst>` - `md template <../template.md>`)_, | ||||||
and filling it in as you go. | ||||||
|
||||||
DEPs must be written in `reStructuredText <http://docutils.sourceforge.net/rst.html>`_ | ||||||
(the same format as Django's documentation). | ||||||
DEPs may be written in `reStructuredText <http://docutils.sourceforge.net/rst.html>`_ | ||||||
(the same format as Django's documentation) or | ||||||
`Markdown <https://www.markdownguide.org>` (the same as GitHub issues). | ||||||
|
||||||
Each DEP should have the following parts: | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think it’d be worth updating the point about preambles below. Perhaps just removing the specifics:
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. updated |
||||||
|
||||||
#. A short descriptive title (e.g. "ORM expressions"), which is also reflected | ||||||
in the DEP's filename (e.g. ``0181-orm-expressions.rst``). | ||||||
|
||||||
#. A preamble -- a rST `field list <http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#field-lists>`_ | ||||||
containing metadata about the DEP, including the DEP number, the names of the | ||||||
various members of the `DEP team <#forming- the-team>`_, and so forth. See | ||||||
`DEP Metadata`_ below for specific details. | ||||||
#. A preamble -- containing metadata about the DEP, including the DEP number, | ||||||
the names of the various members of the `DEP team <#forming- the-team>`_, and so forth. | ||||||
See `DEP Metadata`_ below for specific details. | ||||||
This can be provided as a rST `field list <http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#field-lists>`_ | ||||||
or MarkDown frontmatter `https://github.com/Kernix13/markdown-cheatsheet/blob/master/frontmatter.md`_ | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
depending on which temaplte you are using. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
#. Abstract -- a short (~200 word) description of the technical issue | ||||||
being addressed. | ||||||
|
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -0,0 +1,100 @@ | ||||||
--- | ||||||
DEP: XXXX | ||||||
Author: Jacob Kaplan-Moss | ||||||
Implementation Team: Jacob Kaplan-Moss | ||||||
Shepherd: Andrew Godwin, Carl Meyer | ||||||
Status: Draft | ||||||
Type: Feature | ||||||
Created: 2014-11-16 | ||||||
Last-Modified: 2014-11-18 | ||||||
--- | ||||||
# DEP XXXX: DEP template | ||||||
|
||||||
Table of Contents | ||||||
- [Abstract](#abstract) | ||||||
- [Specification](#specification) | ||||||
- [Motivation](#motivation) | ||||||
- [Rationale](#rationale) | ||||||
- [Backwards Compatibility](#backwards-compatibility) | ||||||
- [Reference Implementation](#reference-implementation) | ||||||
- [Copyright](#copyright) | ||||||
|
||||||
This DEP provides a sample template for creating your own DEPs. In | ||||||
conjunction with the content guidelines in [DEP | ||||||
1](https://github.com/django/deps/blob/main/final/0001-dep-process.rst), this | ||||||
should make it easy for you to conform your own DEPs to the format | ||||||
outlined below. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. In #85 there’s also a mention of removing the wrapping to 80 characters, what do you think of updating this template accordingly? |
||||||
|
||||||
Note: if you are reading this DEP via the web, you should first grab | ||||||
[the source of this | ||||||
DEP](https://raw.githubusercontent.com/django/deps/refs/heads/main/template.rst) in | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Maybe this should link to the Markdown template?
Suggested change
|
||||||
order to complete the steps below. **DO NOT USE THE HTML FILE AS YOUR | ||||||
TEMPLATE!** | ||||||
|
||||||
To get the source this (or any) DEP, look at the top of the Github page | ||||||
and click \"raw\". | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Here and further through the rest of the doc, I think it’d be nice to remove the unnecessary escaping. |
||||||
|
||||||
If you\'re unfamiliar with MarkDown, this template also exists | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
as a [reStructuredText template](./template.rst). | ||||||
|
||||||
Once you\'ve made a copy of this template, remove this abstract, fill | ||||||
out the metadata above and the sections below, then submit the DEP. | ||||||
Follow the guidelines in [DEP | ||||||
1](https://github.com/django/deps/final/0001-dep-process.rst). | ||||||
|
||||||
## Abstract | ||||||
|
||||||
This should be a short (\~200 word) description of the technical issue | ||||||
being addressed. | ||||||
|
||||||
This (and the above metadata) is the only section strictly required to | ||||||
submit a draft DEP; the following sections can be barebones and fleshed | ||||||
out as you work through the DEP process. | ||||||
|
||||||
## Specification | ||||||
|
||||||
This section should contain a complete, detailed technical specification | ||||||
which should describe the syntax and semantics of any new feature. The | ||||||
specification should be detailed enough to allow implementation \-- that | ||||||
is, developers other than the author should (given the right experience) | ||||||
be able to independently implement the feature, given only the DEP. | ||||||
|
||||||
## Motivation | ||||||
|
||||||
This section should explain *why* this DEP is needed. The motivation is | ||||||
critical for DEPs that want to add substantial new features or | ||||||
materially refactor existing ones. It should clearly explain why the | ||||||
existing solutions are inadequate to address the problem that the DEP | ||||||
solves. DEP submissions without sufficient motivation may be rejected | ||||||
outright. | ||||||
|
||||||
## Rationale | ||||||
|
||||||
This section should flesh out out the specification by describing what | ||||||
motivated the specific design and why particular design decisions were | ||||||
made. It should describe alternate designs that were considered and | ||||||
related work. | ||||||
|
||||||
The rationale should provide evidence of consensus within the community | ||||||
and discuss important objections or concerns raised during discussion. | ||||||
|
||||||
## Backwards Compatibility | ||||||
|
||||||
If this DEP introduces backwards incompatibilities, you must must | ||||||
include this section. It should describe these incompatibilities and | ||||||
their severity, and what mitigation you plan to take to deal with these | ||||||
incompatibilities. | ||||||
|
||||||
## Reference Implementation | ||||||
|
||||||
If there\'s an implementation of the feature under discussion in this | ||||||
DEP, this section should include or link to that implementation and | ||||||
provide any notes about installing/using/trying out the implementation. | ||||||
|
||||||
## Copyright | ||||||
|
||||||
This document has been placed in the public domain per the Creative | ||||||
Commons CC0 1.0 Universal license | ||||||
(<http://creativecommons.org/publicdomain/zero/1.0/deed>). | ||||||
|
||||||
(All DEPs must include this exact copyright statement.) |
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -28,16 +28,8 @@ TEMPLATE!** | |||||
To get the source this (or any) DEP, look at the top of the Github page | ||||||
and click "raw". | ||||||
|
||||||
If you're unfamiliar with reStructuredText (the format required of DEPs), | ||||||
see these resources: | ||||||
|
||||||
* `A ReStructuredText Primer`__, a gentle introduction. | ||||||
* `Quick reStructuredText`__, a users' quick reference. | ||||||
* `reStructuredText Markup Specification`__, the final authority. | ||||||
|
||||||
__ http://docutils.sourceforge.net/docs/rst/quickstart.html | ||||||
__ http://docutils.sourceforge.net/docs/rst/quickref.html | ||||||
__ http://docutils.sourceforge.net/spec/rst/reStructuredText.html | ||||||
If you're unfamiliar with reStructuredText, this template also exists as a | ||||||
`MarkDown template <./template.md>`_. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
Once you've made a copy of this template, remove this abstract, fill out the | ||||||
metadata above and the sections below, then submit the DEP. Follow the | ||||||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.