From 59c8c9e4058b35454d4744c2336ca85495d44d27 Mon Sep 17 00:00:00 2001 From: Darren Birkett Date: Wed, 3 Dec 2014 14:01:45 +0000 Subject: [PATCH] update contributor guidelines to be gerrit/launchpad specific Change-Id: Ie1f3649b8cce43e0ada112ffd83b8a8997c5aa8a --- CONTRIBUTING.md | 39 +++++++++++++++++++++------------------ 1 file changed, 21 insertions(+), 18 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 042b1850f8..e9d109c9d1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,27 +1,30 @@ -**contributor guidelines** +###Contributor guidelines +**Filing Bugs** +Bugs should be filed on Launchpad, not GitHub: -When submitting a pull request (PR), or reviewing existing PR's in preparation for merge, please ensure the following criteria are met: + https://bugs.launchpad.net/openstack-ansible -* PR relates to a prior filed issue, and the issue number is included in the body of the PR. -* The PR (not the issue) is targeted at the relevant milestone. If the PR is against master, target the current/latest milestone. -* The issue number is NOT in the title of the commit message. The issue MAY be included in the body of the commit message, but not the title. -* The PR title should be usable to populate the changelog. -* The PR description should clearly describe the functional change being made -* Unrelated functional changes are submitted separately. -* Note any limitations of the fix. -* Fix/feature being added has been coded in a similar style, or taken a similar logical pattern to the rest of the codebase. -* PR should, where possible, relate to a single issue -* All commits relating to a single issue in a PR are squashed to a single commit. -* The commit message and PR title should not contain typos -* The PR should be submitted against the correct branch. If the PR is against master, and the original issue was labeled with 'backport potential', 'cherry-pick -x' the issue from master into the relevant stable branch, and submit a separate PR to that branch - -When submitting an issue, or working on an issue, please ensure the following criteria are met: +When submitting a bug, or working on a bug, please ensure the following criteria are met: * The description clearly states or describes the original problem or root cause of the problem. * Include historical information on how the problem was identified. * Any relevant logs are included. -* If the issue is a bug that needs fixing in a branch other than Master, add the ‘backport potential’ tag TO THE ISSUE (not the PR). * The provided information should be totally self-contained. External access to web services/sites should not be needed. -* If the issue is needed for a hotfix release, add the 'expedite' label. * Steps to reproduce the problem if possible. + +**Submitting Code** + +Changes to the project should be submitted for review via the Gerrit tool, following +the workflow documented at: + + https://wiki.openstack.org/GerritWorkflow + +Pull requests submitted through GitHub will be ignored. + + +**Extra** + +***Tags***: If it's a bug that needs fixing in a branch in addition to Master, add a '\-backport-potential' tag (eg ```juno-backport-potential```). There are predefined tags that will autocomplete +***Status***: Please leave this alone, it should be New till someone triages the issue. +***Importance***: Should only be touched if it is a Blocker/Gating issue. If it is, please set to High, and only use Critical if you have found a bug that can take down whole infrastructures.