]> git.lyx.org Git - features.git/commitdiff
Add a "Development policies" section to dev manual
authorScott Kostyshak <skostysh@lyx.org>
Sun, 8 Feb 2015 21:29:20 +0000 (16:29 -0500)
committerScott Kostyshak <skostysh@lyx.org>
Sun, 8 Feb 2015 21:33:43 +0000 (16:33 -0500)
Writing these policies down makes it easier for newcommers to
understand guidelines and the intuition behind them.

The two policies this commit adds were responses by Georg and Richard
to two threads on the mailing list. The policies are titled
"When to set a fixed milestone" and
"Can we add rc entries in stable branch?".

lib/doc/Development.lyx

index 260dc6c815ec935e30dbf60e416ebec599944b1f..c257ef632002bb2239e973f254e6690be11b3042 100644 (file)
@@ -195,6 +195,13 @@ File Format Numbers
 
 \begin_layout Section
 When is an update of the .lyx file format number needed?
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:When-is-an"
+
+\end_inset
+
+
 \end_layout
 
 \begin_layout Standard
@@ -867,5 +874,62 @@ Commit the changes to the repository, or send a patch to the development
  list and ask for committing if you do not have commit rights.
 \end_layout
 
+\begin_layout Chapter
+Development policies
+\end_layout
+
+\begin_layout Standard
+This chapter lists some guidelines that should be followed.
+ This list is not complete, and many guidelines are in separate chapters,
+ such as 
+\begin_inset Quotes eld
+\end_inset
+
+When is an update of the .lyx file format number needed?
+\begin_inset Quotes erd
+\end_inset
+
+ in Section 
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:When-is-an"
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Section
+When to set a fixed milestone?
+\end_layout
+
+\begin_layout Standard
+Only set a fixed milestone (like 2.1.4 or 2.2.0) if at least one of the following
+ holds:
+\end_layout
+
+\begin_layout Enumerate
+Somebody is actively working on a fix.
+\end_layout
+
+\begin_layout Enumerate
+The bug is so severe that it would block the release if it is not fixed.
+\end_layout
+
+\begin_layout Standard
+If a bug is important, but nobody is working on it, and it is no showstopper,
+ use a milestone like 2.1.x or 2.2.x.
+ For all other bugs, do not set a milestone at all.
+\end_layout
+
+\begin_layout Section
+Can we add rc entries in stable branch?
+\end_layout
+
+\begin_layout Standard
+No.
+ We are supposed to increase the prefs2prefs version number with such things.
+\end_layout
+
 \end_body
 \end_document