Browse Source

Merge "Update template with guidance for bugs over bp"

Zuul 2 months ago
parent
commit
5bea999e57
1 changed files with 22 additions and 4 deletions
  1. 22
    4
      specs/template.rst

+ 22
- 4
specs/template.rst View File

@@ -8,7 +8,7 @@
8 8
 Example Spec - The title of your blueprint
9 9
 ==========================================
10 10
 
11
-`bp example <https://blueprints.launchpad.net/keystone/+spec/example>`_
11
+`bug #XXXXXXX <https://bugs.launchpad.net/keystone/+bug/XXXXXXX>`_
12 12
 
13 13
 
14 14
 Introduction paragraph -- why are we doing anything? A single paragraph of
@@ -21,9 +21,27 @@ Some notes about using this template:
21 21
 
22 22
 * Wrap text at 79 columns.
23 23
 
24
-* The filename in the git repository should match the launchpad URL, for
25
-  example a URL of: https://blueprints.launchpad.net/keystone/+spec/new-feature
26
-  should be named new-feature.rst
24
+* The filename in the git repository should be descriptive of the feature.
25
+  For example, if the feature is called "new feature", the file should be
26
+  named new-feature.rst
27
+
28
+  Note that this process no longer uses the blueprints in launchpad and
29
+  instead uses a bug for tracking. Bugs are superior to blueprints in that
30
+  patches proposed and merged get a comment and comments on bugs are not
31
+  mutable. This ensures that the tracking of patches in our bug tracker
32
+  cannot be accidently lost if someone edits the body of the bug (unlike
33
+  blueprints, where all data is similar to the bug description and has
34
+  no history tracking.
35
+
36
+* You will need to open a bug in launchpad for tracking the changes. This
37
+  bug will be linked in the commit message of each patch for the feature
38
+  (including this specification) so that when a change is made the CI
39
+  system generate a comment on the bug and help us track all work being
40
+  done towards the feature. The bug number should replace the ``XXXXXXX``
41
+  above in the link.
42
+
43
+  Please be sure to use ``partial-bug: #XXXXXXX`` in the commit message
44
+  for landing this spec (where ``XXXXXXX`` is the bug id.
27 45
 
28 46
 * Do not delete any of the sections in this template.  If you have
29 47
   nothing to say for a whole section, just write: None

Loading…
Cancel
Save