Uploaded image for project: 'genius'
  1. genius
  2. GENIUS-129

Genius BP/Fluorine

XMLWordPrintable

    • Icon: Epic Epic
    • Resolution: Unresolved
    • Icon: Medium Medium
    • None
    • None
    • None
    • None
    • bp/fluorine

      Introduction
      Follow this workflow when adding new blueprints. The workflow is borrowed heavily from [OpenStack Blueprint](https://wiki.openstack.org/wiki/Blueprints).

      The following steps should be used for each new blueprint:

      1. Clone the BP Template https://jira.opendaylight.org/browse/GENIUS-128. Open the jira. Select More->Clone.
      2. Update the Summary with the feature name and tag. Pick a short, descriptive tag with hyphens. The card title would be: Long Feature Title (tag).
      3. Update the Description to reference the new blueprint and include the minimum suggested information shown below by replacing the relevant sections in the cloned jira.
      4. Change the assignee to yourself.
      5. Add new user stories and tasks as needed to track further tasks related to the spec.
        1. Break the tasks down into small tasks that can be easily updated to provide status.
        2. Make sure to include the tag as a label on all jiras related to the feature.
      6. For all gerrits related to the blueprint add "Issue: GENIUS-12345" in the commit message just above the Change-ID. Use the jira issue of the blueprint spec jira.

      Blueprint Description

      Update the following:

      1. Feature name and tag. The tag is a short version of the feature that is unique and will be used to track the related gerrits. This tag will be used as the topic for all gerrits related to the blueprint.
      2. High-level description. Provide enough detail for the user to understand the feature.
      3. Specification links. Replace the example gerrit ID with the new blueprint spec gerrit ID.
      4. Link to gerrits: [gerrits](https://git.opendaylight.org/gerrit/#/q/project:genius+branch:master+topic:$TAG). Replace the TAG with the tag created above. This should be the topic selected for all gerrits so that it could be used to track all gerrits related to the feature.
      5. Dependencies (if any).

      Compiling Docs
      Use [Compiling Docs|https://trello.com/c/EEoeAS03/74-compiling-docs] given under netvirt trello to learn how to compile the documentation before pushing the patch.

            k.faseela Faseela K
            k.faseela Faseela K
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated: