Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Update Development Branch section #34

Closed
wants to merge 2 commits into from
Closed

doc: Update Development Branch section #34

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
92a5622
doc: Update documentation to talk about development branches
donaldsharp Oct 16, 2019
b586b11
doc: Update Development Branch section
odd22 Oct 24, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions doc/developer/workflow.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,43 @@ releases have support for this feature request. Moreover, introducing features
requests may result in breaking the stability of the branch. LTS branches are first
done to bring long term support for stability.

Development Branches
--------------------

Occassionally the community will desire the ability to work together
on a feature that is considered useful to FRR. In this case the
parties may ask the Maintainers for the creation of a development
branch in the main FRR repository. Requirements for this to happen
are:

- A one paragraph description of the feature being implemented to
allow for the facilitation of discussion about the feature.
This might include pointers to relevant RFC's or presentations
that explain what is planned or a link to requested feature
(see https://github.com/FRRouting/frr/wiki/Feature-Requests).
This is intended to set a somewhat low bar for organization.
- A person from the FRR Maintainers is designated to shepherd
the development on this branch. The shepherded maintainer is
responsible for keeping the branch up to date, and general
communication about the project with the other FRR Maintainers.
- People interested to contribute to an advance feature in FRR
should have a look to Feature-Requests wiki page where
development branch are listed.
- Commits to this branch must follow the normal PR and commit process
as outlined in other areas of this document. The goal of this is
to prevent the current state where large features are submitted
and are so large they are difficult to review. Failed report from
the CI/CD is acceptable only for the topotest part during the branch
development but must be conform before and the end of development.

After a development branch has completed the work together, a final
review can be made and the branch merged into master (a final rebase
against master should be perform to avoid merge conflict). Once the
branch is merged, it is removed from the FRR repo unless otherwise
specified. If a development branch is becomes un-maintained or not
being actively worked on after 3 months then the Maintainers can
decide to remove the branch.

Changelog
---------
The changelog will be the base for the release notes. A changelog entry for
Expand Down