Page Proposals/BEP-0007 was changed by jdreimann
Diff URL:
https://issues.apache.org/bloodhound/wiki/Proposals/BEP-0007?action=diffversion=2
Revision 2
Changes:
---8--8--8--8--8--8--8--8
Index: Proposals/BEP-0007
=
--- Proposals/BEP-0007 (version: 1)
+++ Proposals/BEP-0007 (version: 2)
@@ -1,1 +1,88 @@
-placeholder for Antonia's proposal-
+
+= BEP BEP number : BEP title #overview
+
+[[PageOutline]]
+
+|| '''BEP''' || BEP number ||
+|| '''Title''' || BEP title ||
+|| '''Version''' || leave blank ||
+|| '''Last-Modified''' || leave blank ||
+|| '''Author''' || Author With Email u...@dom.ain, Author Name Only, or The
Bloodhound project (see [wiki:/Proposals#bep-header-preamble BEP preamble
explained]) ||
+|| '''Status''' || Draft ||
+|| '''Type''' || BEP type (see [wiki:/Proposals#bep-types BEP types
explained]) ||
+|| '''Content-Type''' || [wiki:PageTemplates/Proposals text/x-trac-wiki] ||
+|| '''Created''' || leave blank ||
+|| '''Post-History''' || leave blank ||
+
+
+
+== Abstract #abstract
+
+Delete text in this section and add a short (~200 word) description of the
technical issue being addressed. Take a look at sample abstract below
+
+This template provides a boilerplate or sample template for creating your
+own BEPs. In conjunction with the [wiki:/Proposals general content
guidelines] and the [wiki:/Proposals/Formats/WikiFormatting WikiFormatting BEP
guidelines]
+, this should make it easy for you to conform your own
+BEPs to the format outlined below. See [#howto How to Use This Template] for
further instructions.
+
+**Note**: if you are reading this template via the web, you should first try
to create a new wiki page by selecting `ProposalsRst` |page template guide|.
**DO NOT EDIT THIS WIKI PAGE IN ORDER TO CREATE A NEW BEP! **
+
+If you would prefer not to use WikiFormatting markup in your BEP, please see
[wiki:/Proposals/Formats/RestructuredText reStructuredText BEP guidelines].
+
+== Motivation ==
+
+The motivation is critical for BEPs that want to change the copy of ''Trac''
patched using vendor branch . It should clearly explain why the existing
''Bloodhound'' solution is inadequate to address the problem that the ''BEP''
solves. ''BEP'' submissions without sufficient motivation may be rejected
outright.
+
+== Proposal #proposal
+
+The technical specification should describe any new features , detail its
impact on the components architecture , mention what plugins will be included
as a result , whether they are hosted by [http://trac-hacks.org
trac-hacks.org] or not , and any other relevant technical subject . The
specification should be detailed enough to allow competing, interoperable
implementations for any of the current supported database platforms (e.g.
''SQLite'', ''Postgres'', ''MySQL'') and server technologies (e.g. ''Apache
HTTPD server'', ''nginx'', ''mod_wsgi'', ''CGI'')..
+
+== Rationale #rationale
+
+The rationale fleshes out the specification by describing what motivated the
design and why particular design decisions were made. It should describe
alternate designs that were considered and related work, e.g. how the feature
is supported in other issue trackers or ''Trac'' hacks . The rationale should
provide evidence of consensus within the community and discuss important
objections or concerns raised during discussion. Take a look at sample
rationale below
+
+''BEP'' submissions come in a wide variety of forms, not all adhering to the
format guidelines set forth below. Use this template, in conjunction with the
[wiki:/Proposals general content guidelines] and the
[wiki:/Proposals/Formats/WikiFormatting WikiFormatting BEP guidelines], to
ensure that your ''BEP'' submission is easy to read and understand.
+
+This template allows to create BEPs and is very similar to
[http://www.python.org/dev/peps/pep-0012 PEP 12] . However it has been
optimized by moving long explanations to the
[wiki:/Proposals/Formats/WikiFormatting WikiFormatting BEP guidelines] . If you
are interested take a look at the [?action=diffold_version=1 differences].
The goal is to redact new BEPs just by following in-line instructions between
angle brackets (i.e. ) . Even if this will allow to write BEPs
faster , it is highly recommended to read the
[wiki:/Proposals/Formats/WikiFormatting WikiFormatting BEP guidelines] at least
once in your lifetime to be aware of good practices and expected style rules .
+
+== How to Use This Template #howto
+
+BEPs may include further sections. This is an example.
+
+Quick edits will consist in following the instructions inside angle brackets
(i.e. ) . That should be everything needed to write new BEPs. To be
more informed about advanced considerations please read the [wiki:/Proposals
general content guidelines] and the [wiki:/Proposals/Formats/WikiFormatting
WikiFormatting BEP guidelines] .
