From 2b2d011d368701b6c01f70b02bb9e79dae3e544e Mon Sep 17 00:00:00 2001 From: Adam Miller Date: Jan 10 2017 21:48:59 +0000 Subject: [PATCH 1/3] add dev workflow docs Signed-off-by: Adam Miller --- diff --git a/README.rst b/README.rst index 25ca023..6bc1052 100644 --- a/README.rst +++ b/README.rst @@ -50,6 +50,60 @@ Directory layout of this git repository: - tests - Tests, run with ``runtests.sh`` (uses `pytest`_ for tests) +Development Workflow +==================== + +In this repository you will find two "main" branches, ``master`` and +``develop``. All development should happen in ``develop`` and pull requests from +the Release Engineering Tooling Development Team as well as the more broad +Fedora Community of contributors will go to ``develop``. + +The ``master`` branch is meant to be the current stable branch that has all +tests passing and has passed a code audit. This does not mean that the +``master`` branch is always the latest release but simply that the code is +stable and in a known good state. Releases will happen as point in time +snapshots of ``master`` via ``git tag`` operation. + +Example +------- + +An example of a developer's workflow is shown in the diagram below using ``*`` +to indicate a merge event. + +:: + + [master] -------------------*---------------------------------------> + / + [pull request, code audit/review] + / + [develop] ----------*----+-------+--------------------*--------------> + / \ / + [pull request] [rebase] [pull request] + [contrib / \ / + topic ------+--------------------*------------+------------------> + branch] + + +Here a contributing developer will submit pull requests from a `topic branch`_ +within their own fork of this repository to the ``develop`` branch. Once this is +done then a standard review will take place by a member of the Fedora RelEng +Group in `FAS`_ and they will merge the code into ``develop``. + +At the point in time there is a desire to merge the ``develop`` branch into +``master`` because a major feature is complete or otherwise, a new pull request +should be filed by a member of the Fedora RelEng Team and a code audit and final +review will begin. + +Security Audits and Final Review +-------------------------------- + +Currently the following people are approved for code security audits and final +code review. However, no one should ever audit and merge their own code, no +matter if they are on this list or not. + +* `Patrick Uiterwijk`_ +* `Adam Miller`_ + .. _pytest: http://pytest.org/ .. _Fedora: https://getfedora.org/ From 6331ee28309de59f030622064af4a02562ffacd7 Mon Sep 17 00:00:00 2001 From: Adam Miller Date: Jan 10 2017 21:50:56 +0000 Subject: [PATCH 2/3] satisfy the references to urls Signed-off-by: Adam Miller --- diff --git a/README.rst b/README.rst index 6bc1052..884e445 100644 --- a/README.rst +++ b/README.rst @@ -112,3 +112,8 @@ matter if they are on this list or not. .. _Fedora Release Engineering pagure git repo: https://pagure.io/releng .. _RelEng Automation: https://pagure.io/releng-automation .. _click: http://click.pocoo.org +.. _Patrick Uiterwijk: https://fedoraproject.org/wiki/User:Puiterwijk +.. _Adam Miller: https://fedoraproject.org/wiki/User:Maxamillion +.. _FAS: https://fedoraproject.org/wiki/Account_System +.. _topic branch: + https://git-scm.com/book/en/v2/Git-Branching-Branching-Workflows#Topic-Branches From 3308e4f3a0309248b08532be7a0ce9daac0accfa Mon Sep 17 00:00:00 2001 From: Adam Miller Date: Jan 10 2017 21:54:13 +0000 Subject: [PATCH 3/3] add note about develop rebasing on master Signed-off-by: Adam Miller --- diff --git a/README.rst b/README.rst index 884e445..5485f18 100644 --- a/README.rst +++ b/README.rst @@ -72,11 +72,11 @@ to indicate a merge event. :: - [master] -------------------*---------------------------------------> - / - [pull request, code audit/review] - / - [develop] ----------*----+-------+--------------------*--------------> + [master] ---+-------------------------------*------------------------> + \ / + [rebase] [pull request, code audit/review] + \ / + [develop] -------*--*----+-------+-------+------------*--------------> / \ / [pull request] [rebase] [pull request] [contrib / \ / @@ -94,6 +94,8 @@ At the point in time there is a desire to merge the ``develop`` branch into should be filed by a member of the Fedora RelEng Team and a code audit and final review will begin. +The ``develop`` branch should always be rebased on ``master`` when necessary. + Security Audits and Final Review --------------------------------