Skip to content

GiveFeedback

John Mertic edited this page Jan 28, 2016 · 1 revision

Giving Feedback on the Spec

Anyone can provide open feedback on the spec by opening issues on the ODPi JIRA system. These issues are scrubbed by the ODPi Release Team and Release Manager on a weekly basis.

Submitting an ODPi JIRA ticket against the spec

  1. If you haven't already, create a Linux Foundation account. Note the username and password you selected.

  2. Login to the ODPi JIRA with the Linux Foundation username and password you selected above.

  3. In the menubar, click 'Create'. The Create dialog will come up JIRA Create Issue button

  4. The screen that comes up, you'll need to fill out the following items:

    • Project: 'ODPi' ( should be the default option )
    • Issue Type: Select 'Improvement' or 'Bug' as appropriate ( don't worry if you get this wrong )
    • Summary: One line subject of the feedback or issue seen
    • Description: Detailed explanation of the feedback or concerns seen with the spec.

JIRA Create Issue screen

Providing proposed changes to the spec

If you want to directly supply changes to the spec, you can couple your JIRA ticket with a Pull Request against the spec. To do this:

  1. Complete the CLA for your organization if you are contributing on behalf of one, or an individual CLA if not.
  2. Go to the spec repo, and select the spec you wish to provide an edit to.
  3. Make the changes in the GitHub editor.
  4. At the bottom of the screen, you will be instructed to make a commit to a forked copy on your GitHub account, with the intention of starting a pull request. Note that you should have the JIRA ticket number as the branch name or in the commit message so it will be automatically linked to the JIRA ticket. Commit Pull Request screen
  5. On the screen that follows, you can issue the pull request. Pull Request screen
You can’t perform that action at this time.