summaryrefslogtreecommitdiff
path: root/doc/developer/workflow.rst
diff options
context:
space:
mode:
authorDavid Lamparter <equinox@opensourcerouting.org>2022-12-02 11:39:56 +0100
committerDavid Lamparter <equinox@opensourcerouting.org>2022-12-08 12:06:37 +0100
commitad5fef3dedb22a94b41e058000c412f199cac738 (patch)
tree4ece606c091d916f7bbc43a925280fe8f20bc18d /doc/developer/workflow.rst
parent91aaed76c5043b848de243bd6161996f66eaa2cd (diff)
doc: introduce FRR community "accords"
The idea here is to pass "non-code agreements" through the PR review mechanism, and have them visible in the git tree. Two "example" (but real) accords are included, mostly to illustrate the idea. Both of these should be non-controversial and have had some previous discussion in random places. Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
Diffstat (limited to 'doc/developer/workflow.rst')
-rw-r--r--doc/developer/workflow.rst15
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/developer/workflow.rst b/doc/developer/workflow.rst
index b8e298dd3c..b0d320b5ea 100644
--- a/doc/developer/workflow.rst
+++ b/doc/developer/workflow.rst
@@ -308,6 +308,21 @@ your changes is usually not required and will be added based on your commit
messages by the maintainers. However, you are free to include an update to the
changelog with some better description.
+Accords: non-code community consensus
+=====================================
+
+The FRR repository has a place for "accords" - these are items of
+consideration for FRR that influence how we work as a community, but either
+haven't resulted in code *yet*, or may *never* result in code being written.
+They are placed in the ``doc/accords/`` directory.
+
+The general idea is to simply pass small blurbs of text through our normal PR
+procedures, giving them the same visibility, comment and review mechanisms as
+code PRs - and changing them later is another PR. Please refer to the README
+file in ``doc/accords/`` for further details. The file names of items in that
+directory are hopefully helpful in determining whether some of them might be
+relevant to your work.
+
Submitting Patches and Enhancements
===================================