Difference between revisions of "Fuel/How to contribute"

Revision as of 20:40, 12 April 2014

Where and how to contribute

Overview

Fuel is large project which intersect Programming, Linux and Networking. It is written in Python, Ruby and JavaScript. It also has a number of build scripts in bash & make. Documentation is written in Sphinx. We are welcome you to contribute in any area of the above or beyond.

Bugs verification

This is very easy to get started, but help here is actually very valuable. Especially when it comes to bugfixes which are relevant to only certain types of hardware. When bugfix is merged, bug is automatically moves to "Fix Committed" status. In Fuel, we set "Fix Released" status for a bug only when it was verified by someone else than a developer. You can simple check out all fix committed bugs and start verifying them. It is required to be in fuel-bugs LP group to be able to change bug status. However you can leave a comment in bug report, and it will be enough for bug supervisors to change bug status. By your request, you can be included into fuel-bugs team to manage bugs yourself.

Test and report bugs

You can always build a developers ISO from master following instructions at http://docs.mirantis.com/fuel-dev/develop/env.html#building-the-fuel-iso. Test different deployment modes, and file bugs. Please do not hesitate to share your findings in IRC for any details you would want to know. Feel free to file bug in a format you want, however it would be great to see a bug in a certain format, with all details in place - to easily reproduce and save a time of developers. You can follow the following simple guidance, which a little bit extend official OpenStack Bugs page.

The bugs you report for Fuel can be either “Public” or “Private”. Private bugs become visible only for Dev, QA, and Support teams. The guidance is as follows:

• Normally you would want to report a “Public” bug
• However, if a bug contains any sensitive information, or security leak information, please report a “Private” bug

Here is how you file a bug:

• Go to https://launchpad.net/fuel
• Select “Report a bug” on the right
• Fill in “Summary” field for a bug. It is going to be the headline. Please be descriptive but short and to the point.
  • Bad - "Savanna doesn’t install"
  • Good - "Savanna fails to install in HA mode when “Neutron with VLANs” network is selected"
• Enter “Further information”. This is a bug description. It should contain the following sections:
  • Description of the environment. Provide enough relevant information:
    • Output of http://fuel-master-node:8000/api/version/
    • Operating System
    • Reference Architecture (HA / non-HA)
    • Network model (Nova-network, Neutron+VLAN, Neutron+GRE, etc.)
    • Related Projects installed (Savanna, Murano, Ceilometer)
  • Steps to reproduce
    • Bad: Run the deployment in HA configuration
    • Good:
      1. Create a new cluster
      2. Select HA mode, “Neutron with VLANs” for network, and choose to install Savanna
      3. Leave defaults the rest of the settings. Run cluster installation
  • Expected result:
    • Good: Savanna is deployed, up and running.
  • Actual result:
    • Bad: Savanna fails to install.
    • Good: Savanna installation fails with the error message “xxx”. Please see the attached screenshot which shows the errors on “Logs” tab.
  • Workaround
    • Bad: Don’t use “Neutron with VLANs”
    • Good: Switch network mode to “Neutron with GRE” for the deployment to complete successfully.
  • Impact
    • Bad: Needs to be fixed.
    • Good: deployment cannot be completed, because customer requires us to implement a use case for Savanna and “Neutron with VLANs”. Changing configuration to “Neutron with GRE” is not as acceptable option here so this has to be addressed as soon as possible.
• Select visibility for the bug under “This bug contains information that is” field. Either leave it as “Public” (default) or set it to “Private” per the above guidance
• Add attachments under “Extra Options” section
  • Logs
  • Diagnostic snapshot
  • Screenshots
• After everything is entered, select the “Submit bug report” button

Bugs confirmation and triaging

This has nothing different from OpenStack documentation. Please follow Bugs and BugTriage pages.

Suggest enhancements

Enhancements should be proposed using the mechanism of blueprints. The process is very similar to the bugs.

• Select Register a Blueprint. Typically, you’ll find this on the right side of the launchpad page.
• Enter a Name for the blueprint
  • If possible, include the name of the sub-component of fuel as the first word of the name (or just fuel for a broader blueprint), then a very short descriptor using dashes between each word. For example:
    • ui-declarative-wizard
    • fuel-stop-deployment
• Enter a Title for the blueprint. The title should describe the feature as clearly as possible in up to 70 characters. This title is displayed in every feature list or report.
• In the Specification URL, enter a URL to an externally available document that contains the design document.
  • If one does not already exist, you can create a new one. Please use Fuel Design Template Document.
  • If you’re just entering a new idea without a design, then you can leave this field blank.
• Enter a Summary of the blueprint.
  • Summarize the idea of the blueprint in a user story. If you have an existing user story in a public document, include the link.
    • If a public document isn’t yet created and the user story is extensive, you can use https://etherpad.openstack.org/ to document the full user story. You can use the Name that you used for the blueprint as the Pad name.
• You won’t need to enter any other fields, so now just choose Register Blueprint.