From d1b45245e0a98adcc06f040cf596dfdcb653ff97 Mon Sep 17 00:00:00 2001 From: David Enyeart Date: Tue, 10 Nov 2020 09:17:49 -0500 Subject: [PATCH] Update Jira instructions in contributing guide Update contributing guide to indicate that Jira issues are not required when submitting a PR. Signed-off-by: David Enyeart (cherry picked from commit cd623d729936e83a7b0ed48440573b725c79c60e) --- docs/source/CONTRIBUTING.rst | 27 +++++++------ docs/source/jira_navigation.rst | 72 --------------------------------- 2 files changed, 14 insertions(+), 85 deletions(-) delete mode 100644 docs/source/jira_navigation.rst diff --git a/docs/source/CONTRIBUTING.rst b/docs/source/CONTRIBUTING.rst index fd8292ba4f8..7546b0297d4 100644 --- a/docs/source/CONTRIBUTING.rst +++ b/docs/source/CONTRIBUTING.rst @@ -246,7 +246,7 @@ Reporting bugs ~~~~~~~~~~~~~~ If you are a user and you have found a bug, please submit an issue using -`JIRA `__. +`JIRA `__. Before you create a new JIRA issue, please try to search the existing items to be sure no one else has previously reported it. If it has been previously reported, then you might add a comment that you also are interested in seeing @@ -277,8 +277,8 @@ for a detailed workflow. Fixing issues and working stories ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Review the `issues -list `__ and find +Fabric issues and bugs are managed in `JIRA `__. +Review the list of issues and find something that interests you. You could also check the `"help-wanted" `__ list. It is wise to start with something relatively straight forward and @@ -288,6 +288,10 @@ assignment if you cannot finish in a reasonable time, or add a comment saying that you are still actively working the issue if you need a little more time. +While Jira tracks a backlog of known issues that could be worked in the future, +if you intend to immediately work on a change that does not yet have a corresponding Jira issue, +you can submit a pull request to `Github `__ without linking to an existing Jira issue. + Reviewing submitted Pull Requests (PRs) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -351,12 +355,12 @@ What makes a good pull request? regression, it is much easier to identify the culprit commit than if we have some composite change that impacts more of the code. -- Include a link to the JIRA story for the change. Why? Because a) we - want to track our velocity to better judge what we think we can - deliver and when and b) because we can justify the change more - effectively. In many cases, there should be some discussion around a - proposed change and we want to link back to that from the change - itself. +- If there is a corresponding Jira issue or bug, include a link to the + Jira issue in the PR summary and commit message. + Why? Because the maintainer that merges the PR will need to close + any corresponding Jira issue. + Also, in many cases, there will be additional discussion around + a proposed change or bug in Jira. - Include unit and integration tests (or changes to existing tests) with every change. This does not mean just happy path testing, @@ -398,9 +402,7 @@ What makes a good pull request? - Write a meaningful commit message. Include a meaningful 55 (or less) character title, followed by a blank line, followed by a more - comprehensive description of the change. Each change MUST include the JIRA - identifier corresponding to the change (e.g. [FAB-1234]). This can be - in the title but should also be in the body of the commit message. + comprehensive description of the change. .. note:: Example commit message: @@ -449,7 +451,6 @@ Related Topics .. toctree:: :maxdepth: 1 - jira_navigation dev-setup/devenv dev-setup/build style-guides/go-style diff --git a/docs/source/jira_navigation.rst b/docs/source/jira_navigation.rst deleted file mode 100644 index 0608bca7583..00000000000 --- a/docs/source/jira_navigation.rst +++ /dev/null @@ -1,72 +0,0 @@ -Using Jira to understand current work items -=========================================== - -This document has been created to give further insight into the work in -progress towards the Hyperledger Fabric v1 architecture based on the -community roadmap. The requirements for the roadmap are being tracked in -`Jira `__. - -It was determined to organize in sprints to better track and show a -prioritized order of items to be implemented based on feedback received. -We’ve done this via boards. To see these boards and the priorities click -on **Boards** -> **Manage Boards**: - -.. figure:: images/Jira.png - :alt: Jira boards - - Jira boards - -Now on the left side of the screen click on **All boards**: - -.. figure:: images/Jira1.png - :alt: Jira boards - - Jira boards - -On this page you will see all the public (and restricted) boards that -have been created. If you want to see the items with current sprint -focus, click on the boards where the column labeled **Visibility** is -**All Users** and the column **Board type** is labeled **Scrum**. For -example the **Board Name** Consensus: - -.. figure:: images/Jira2.png - :alt: Jira boards - - Jira boards - -When you click on Consensus under **Board name** you will be directed to -a page that contains the following columns: - -.. figure:: images/Jira3.png - :alt: Jira boards - - Jira boards - -The meanings to these columns are as follows: - -- Backlog – list of items slated for the current sprint (sprints are - defined in 2 week iterations), but are not currently in progress -- In progress – items currently being worked by someone in the - community. -- In Review – items waiting to be reviewed and merged in GitHub -- Done – items merged and complete in the sprint. - -If you want to see all items in the backlog for a given feature set, -click on the stacked rows on the left navigation of the screen: - -.. figure:: images/Jira4.png - :alt: Jira boards - - Jira boards - -This shows you items slated for the current sprint at the top, and all -items in the backlog at the bottom. Items are listed in priority order. - -If there is an item you are interested in working on, want more -information or have questions, or if there is an item that you feel -needs to be in higher priority, please add comments directly to the Jira -item. All feedback and help is very much appreciated. - -.. Licensed under Creative Commons Attribution 4.0 International License - https://creativecommons.org/licenses/by/4.0/ -