proxmox-mirrors/mirror_frr
1
0
Fork 0
mirror of https://git.proxmox.com/git/mirror_frr synced 2025-08-08 10:56:37 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: add some text about git forks

Browse Source 
Add some general guidance about creating and using a fork
of the FRR repository to the workflow doc.

Signed-off-by: Mark Stapp <mjs@cisco.com>
This commit is contained in:
Mark Stapp 2024-09-10 15:29:12 -04:00
parent d27ce6b7be
commit c21d29b5f0
1 changed files with 15 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
doc/developer/workflow.rst
View File

@ -6,9 +6,10 @@ Process & Workflow
.. highlight:: none .. highlight:: none
FRR is a large project developed by many different groups. This section FRR is a large project developed by many different groups. This
documents standards for code style & quality, commit messages, pull requests section documents standards for code style & quality, commit messages,
and best practices that all contributors are asked to follow. pull requests (PRs) and best practices that all contributors are asked
to follow.
This chapter is "descriptive/post-factual" in that it documents pratices that This chapter is "descriptive/post-factual" in that it documents pratices that
are in use; it is not "definitive/pre-factual" in prescribing practices. This are in use; it is not "definitive/pre-factual" in prescribing practices. This
@ -241,7 +242,7 @@ discontinued.
The LTS branch duties are the following ones: The LTS branch duties are the following ones:
- organise meetings on a (bi-)weekly or monthly basis, the handling of issues - organise meetings on a (bi-)weekly or monthly basis, the handling of issues
and pull requested relative to that branch. When time permits, this may be done and pull requests relative to that branch. When time permits, this may be done
during the regularly scheduled FRR meeting. during the regularly scheduled FRR meeting.
- ensure the stability of the branch, by using and eventually adapting the - ensure the stability of the branch, by using and eventually adapting the
@ -324,11 +325,17 @@ relevant to your work.
Submitting Patches and Enhancements Submitting Patches and Enhancements
=================================== ===================================
FRR accepts patches using GitHub pull requests. FRR accepts patches using GitHub pull requests (PRs). The typical FRR
developer will maintain a fork of the FRR project in GitHub; see the
GitHub documentation for help setting up an account and creating a
fork repository. Keep the ``master`` branch of your fork up-to-date
with the FRR version. Create a dev branch in your fork and commit your
work there. When ready, create a pull-request between your dev branch
in your fork and the main FRR repository in GitHub.
The base branch for new contributions and non-critical bug fixes should be The base branch for new contributions and non-critical bug fixes
``master``. Please ensure your pull request is based on this branch when you should be ``master``. Please ensure your pull request targets this
submit it. branch when you submit it.
Code submitted by pull request will be automatically tested by one or more CI Code submitted by pull request will be automatically tested by one or more CI
systems. Once the automated tests succeed, other developers will review your systems. Once the automated tests succeed, other developers will review your