[FFmpeg-devel] [PATCH 2/2] doc: Merge doc/dev_community/* and Code of Conduct into a seperate file
Thilo Borgmann
thilo.borgmann at mail.de
Wed Feb 8 17:57:53 EET 2023
Remove doc/dev_communit markup files completely as they are at the wrong place.
Create a new community page, merging all of doc/dev_community and subsection Code of Conduct into a common place.
The corresponding patch to ffmpeg-web puts the Organisation & Code of Conduct into a seperate community chapter on the FFmpeg website.
---
doc/Makefile | 1 +
doc/community.texi | 173 ++++++++++++++++++++++++
doc/dev_community/community.md | 83 ------------
doc/dev_community/resolution_process.md | 91 -------------
doc/developer.texi | 29 ----
doc/mailing-list-faq.texi | 2 +-
6 files changed, 175 insertions(+), 204 deletions(-)
create mode 100644 doc/community.texi
delete mode 100644 doc/dev_community/community.md
delete mode 100644 doc/dev_community/resolution_process.md
diff --git a/doc/Makefile b/doc/Makefile
index 25774c7bad..67586e4b74 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -19,6 +19,7 @@ MANPAGES3 = $(LIBRARIES-yes:%=doc/%.3)
MANPAGES = $(MANPAGES1) $(MANPAGES3)
PODPAGES = $(AVPROGS-yes:%=doc/%.pod) $(AVPROGS-yes:%=doc/%-all.pod) $(COMPONENTS-yes:%=doc/%.pod) $(LIBRARIES-yes:%=doc/%.pod)
HTMLPAGES = $(AVPROGS-yes:%=doc/%.html) $(AVPROGS-yes:%=doc/%-all.html) $(COMPONENTS-yes:%=doc/%.html) $(LIBRARIES-yes:%=doc/%.html) \
+ doc/community.html \
doc/developer.html \
doc/faq.html \
doc/fate.html \
diff --git a/doc/community.texi b/doc/community.texi
new file mode 100644
index 0000000000..21125d34d2
--- /dev/null
+++ b/doc/community.texi
@@ -0,0 +1,173 @@
+\input texinfo @c -*- texinfo -*-
+ at documentencoding UTF-8
+
+ at settitle Community
+ at titlepage
+ at center @titlefont{Community}
+ at end titlepage
+
+ at top
+
+ at contents
+
+ at anchor{Organisation}
+ at chapter Organisation
+
+The FFmpeg project is organized through a community working on global consensus.
+
+Decisions are taken by the ensemble of active members, through voting and are aided by two committees.
+
+ at anchor{General Assembly}
+ at chapter General Assembly
+
+The ensemble of active members is called the General Assembly (GA).
+
+The General Assembly is sovereign and legitimate for all its decisions regarding the FFmpeg project.
+
+The General Assembly is made up of active contributors.
+
+Contributors are considered "active contributors" if they have pushed more than 20 patches in the last 36 months in the main FFmpeg repository, or if they have been voted in by the GA.
+
+Additional members are added to the General Assembly through a vote after proposal by a member of the General Assembly. They are part of the GA for two years, after which they need a confirmation by the GA.
+
+ at anchor{Voting}
+ at chapter Voting
+
+Voting is done using a ranked voting system, currently running on https://vote.ffmpeg.org/ .
+
+Majority vote means more than 50% of the expressed ballots.
+
+ at anchor{Technical Committee}
+ at chapter Technical Committee
+
+The Technical Committee (TC) is here to arbitrate and make decisions when technical conflicts occur in the project. They will consider the merits of all the positions, judge them and make a decision.
+
+The TC resolves technical conflicts but is not a technical steering committee.
+
+Decisions by the TC are binding for all the contributors.
+
+Decisions made by the TC can be re-opened after 1 year or by a majority vote of the General Assembly, requested by one of the member of the GA.
+
+The TC is elected by the General Assembly for a duration of 1 year, and is composed of 5 members. Members can be re-elected if they wish. A majority vote in the General Assembly can trigger a new election of the TC.
+
+The members of the TC can be elected from outside of the GA. Candidates for election can either be suggested or self-nominated.
+
+The conflict resolution process is detailed in the resolution process document.
+
+The TC can be contacted at <tc at ffmpeg>.
+
+ at anchor{Resolution Process}
+ at section Resolution Process
+
+The Technical Committee (TC) is here to arbitrate and make decisions when technical conflicts occur in the project.
+
+The TC main role is to resolve technical conflicts. It is therefore not a technical steering committee, but it is understood that some decisions might impact the future of the project.
+
+ at subsection Seizing
+
+The TC can take possession of any technical matter that it sees fit.
+
+To involve the TC in a matter, email tc@ or CC them on an ongoing discussion.
+
+As members of TC are developers, they also can email tc@ to raise an issue.
+ at subsection Announcement
+
+The TC, once seized, must announce itself on the main mailing list, with a [TC] tag.
+
+The TC has 2 modes of operation: a RFC one and an internal one.
+
+If the TC thinks it needs the input from the larger community, the TC can call for a RFC. Else, it can decide by itself.
+
+If the disagreement involves a member of the TC, that member should recuse themselves from the decision.
+
+The decision to use a RFC process or an internal discussion is a discretionary decision of the TC.
+
+The TC can also reject a seizure for a few reasons such as: the matter was not discussed enough previously; it lacks expertise to reach a beneficial decision on the matter; or the matter is too trivial.
+ at subsection RFC call
+
+In the RFC mode, one person from the TC posts on the mailing list the technical question and will request input from the community.
+
+The mail will have the following specification:
+
+ a precise title
+ a specific tag [TC RFC]
+ a top-level email
+ contain a precise question that does not exceed 100 words and that is answerable by developers
+ may have an extra description, or a link to a previous discussion, if deemed necessary,
+ contain a precise end date for the answers.
+
+The answers from the community must be on the main mailing list and must have the following specification:
+
+ keep the tag and the title unchanged
+ limited to 400 words
+ a first-level, answering directly to the main email
+ answering to the question.
+
+Further replies to answers are permitted, as long as they conform to the community standards of politeness, they are limited to 100 words, and are not nested more than once. (max-depth=2)
+
+After the end-date, mails on the thread will be ignored.
+
+Violations of those rules will be escalated through the Community Committee.
+
+After all the emails are in, the TC has 96 hours to give its final decision. Exceptionally, the TC can request an extra delay, that will be notified on the mailing list.
+ at subsection Within TC
+
+In the internal case, the TC has 96 hours to give its final decision. Exceptionally, the TC can request an extra delay.
+ at subsection Decisions
+
+The decisions from the TC will be sent on the mailing list, with the [TC] tag.
+
+Internally, the TC should take decisions with a majority, or using ranked-choice voting.
+
+The decision from the TC should be published with a summary of the reasons that lead to this decision.
+
+The decisions from the TC are final, until the matters are reopened after no less than one year.
+
+ at anchor{Community Committee}
+ at chapter Community Committee
+
+The Community Committee (CC) is here to arbitrage and make decisions when inter-personal conflicts occur in the project. It will decide quickly and take actions, for the sake of the project.
+
+The CC can remove privileges of offending members, including removal of commit access and temporary ban from the community.
+
+Decisions made by the CC can be re-opened after 1 year or by a majority vote of the General Assembly. Indefinite bans from the community must be confirmed by the General Assembly, in a majority vote.
+
+The CC is elected by the General Assembly for a duration of 1 year, and is composed of 5 members. Members can be re-elected if they wish. A majority vote in the General Assembly can trigger a new election of the CC.
+
+The members of the CC can be elected from outside of the GA. Candidates for election can either be suggested or self-nominated.
+
+The CC is governed by and responsible for enforcing the Code of Conduct.
+
+The CC can be contacted at <cc at ffmpeg>.
+
+ at anchor{Code of Conduct}
+ at chapter Code of Conduct
+
+Be friendly and respectful towards others and third parties.
+Treat others the way you yourself want to be treated.
+
+Be considerate. Not everyone shares the same viewpoint and priorities as you do.
+Different opinions and interpretations help the project.
+Looking at issues from a different perspective assists development.
+
+Do not assume malice for things that can be attributed to incompetence. Even if
+it is malice, it's rarely good to start with that as initial assumption.
+
+Stay friendly even if someone acts contrarily. Everyone has a bad day
+once in a while.
+If you yourself have a bad day or are angry then try to take a break and reply
+once you are calm and without anger if you have to.
+
+Try to help other team members and cooperate if you can.
+
+The goal of software development is to create technical excellence, not for any
+individual to be better and "win" against the others. Large software projects
+are only possible and successful through teamwork.
+
+If someone struggles do not put them down. Give them a helping hand
+instead and point them in the right direction.
+
+Finally, keep in mind the immortal words of Bill and Ted,
+"Be excellent to each other."
+
+ at bye
diff --git a/doc/dev_community/community.md b/doc/dev_community/community.md
deleted file mode 100644
index 59519393e2..0000000000
--- a/doc/dev_community/community.md
+++ /dev/null
@@ -1,83 +0,0 @@
-# FFmpeg project
-
-## Organisation
-
-The FFmpeg project is organized through a community working on global consensus.
-
-Decisions are taken by the ensemble of active members, through voting and
-are aided by two committees.
-
-## General Assembly
-
-The ensemble of active members is called the General Assembly (GA).
-
-The General Assembly is sovereign and legitimate for all its decisions
-regarding the FFmpeg project.
-
-The General Assembly is made up of active contributors.
-
-Contributors are considered "active contributors" if they have pushed more
-than 20 patches in the last 36 months in the main FFmpeg repository, or
-if they have been voted in by the GA.
-
-Additional members are added to the General Assembly through a vote after
-proposal by a member of the General Assembly.
-They are part of the GA for two years, after which they need a confirmation by
-the GA.
-
-## Voting
-
-Voting is done using a ranked voting system, currently running on https://vote.ffmpeg.org/ .
-
-Majority vote means more than 50% of the expressed ballots.
-
-## Technical Committee
-
-The Technical Committee (TC) is here to arbitrate and make decisions when
-technical conflicts occur in the project.
-They will consider the merits of all the positions, judge them and make a
-decision.
-
-The TC resolves technical conflicts but is not a technical steering committee.
-
-Decisions by the TC are binding for all the contributors.
-
-Decisions made by the TC can be re-opened after 1 year or by a majority vote
-of the General Assembly, requested by one of the member of the GA.
-
-The TC is elected by the General Assembly for a duration of 1 year, and
-is composed of 5 members.
-Members can be re-elected if they wish. A majority vote in the General Assembly
-can trigger a new election of the TC.
-
-The members of the TC can be elected from outside of the GA.
-Candidates for election can either be suggested or self-nominated.
-
-The conflict resolution process is detailed in the [resolution process](resolution_process.md) document.
-
-The TC can be contacted at <tc at ffmpeg>.
-
-## Community committee
-
-The Community Committee (CC) is here to arbitrage and make decisions when
-inter-personal conflicts occur in the project. It will decide quickly and
-take actions, for the sake of the project.
-
-The CC can remove privileges of offending members, including removal of
-commit access and temporary ban from the community.
-
-Decisions made by the CC can be re-opened after 1 year or by a majority vote
-of the General Assembly. Indefinite bans from the community must be confirmed
-by the General Assembly, in a majority vote.
-
-The CC is elected by the General Assembly for a duration of 1 year, and is
-composed of 5 members.
-Members can be re-elected if they wish. A majority vote in the General Assembly
-can trigger a new election of the CC.
-
-The members of the CC can be elected from outside of the GA.
-Candidates for election can either be suggested or self-nominated.
-
-The CC is governed by and responsible for enforcing the Code of Conduct.
-
-The CC can be contacted at <cc at ffmpeg>.
diff --git a/doc/dev_community/resolution_process.md b/doc/dev_community/resolution_process.md
deleted file mode 100644
index 4ed0b63c43..0000000000
--- a/doc/dev_community/resolution_process.md
+++ /dev/null
@@ -1,91 +0,0 @@
-# Technical Committee
-
-_This document only makes sense with the rules from [the community document](community)_.
-
-The Technical Committee (**TC**) is here to arbitrate and make decisions when
-technical conflicts occur in the project.
-
-The TC main role is to resolve technical conflicts.
-It is therefore not a technical steering committee, but it is understood that
-some decisions might impact the future of the project.
-
-# Process
-
-## Seizing
-
-The TC can take possession of any technical matter that it sees fit.
-
-To involve the TC in a matter, email tc@ or CC them on an ongoing discussion.
-
-As members of TC are developers, they also can email tc@ to raise an issue.
-
-## Announcement
-
-The TC, once seized, must announce itself on the main mailing list, with a _[TC]_ tag.
-
-The TC has 2 modes of operation: a RFC one and an internal one.
-
-If the TC thinks it needs the input from the larger community, the TC can call
-for a RFC. Else, it can decide by itself.
-
-If the disagreement involves a member of the TC, that member should recuse
-themselves from the decision.
-
-The decision to use a RFC process or an internal discussion is a discretionary
-decision of the TC.
-
-The TC can also reject a seizure for a few reasons such as:
-the matter was not discussed enough previously; it lacks expertise to reach a
-beneficial decision on the matter; or the matter is too trivial.
-
-### RFC call
-
-In the RFC mode, one person from the TC posts on the mailing list the
-technical question and will request input from the community.
-
-The mail will have the following specification:
-* a precise title
-* a specific tag [TC RFC]
-* a top-level email
-* contain a precise question that does not exceed 100 words and that is answerable by developers
-* may have an extra description, or a link to a previous discussion, if deemed necessary,
-* contain a precise end date for the answers.
-
-The answers from the community must be on the main mailing list and must have
-the following specification:
-* keep the tag and the title unchanged
-* limited to 400 words
-* a first-level, answering directly to the main email
-* answering to the question.
-
-Further replies to answers are permitted, as long as they conform to the
-community standards of politeness, they are limited to 100 words, and are not
-nested more than once. (max-depth=2)
-
-After the end-date, mails on the thread will be ignored.
-
-Violations of those rules will be escalated through the Community Committee.
-
-After all the emails are in, the TC has 96 hours to give its final decision.
-Exceptionally, the TC can request an extra delay, that will be notified on the
-mailing list.
-
-### Within TC
-
-In the internal case, the TC has 96 hours to give its final decision.
-Exceptionally, the TC can request an extra delay.
-
-
-## Decisions
-
-The decisions from the TC will be sent on the mailing list, with the _[TC]_ tag.
-
-Internally, the TC should take decisions with a majority, or using
-ranked-choice voting.
-
-The decision from the TC should be published with a summary of the reasons that
-lead to this decision.
-
-The decisions from the TC are final, until the matters are reopened after
-no less than one year.
-
diff --git a/doc/developer.texi b/doc/developer.texi
index 31b485b0f6..1275fa4f84 100644
--- a/doc/developer.texi
+++ b/doc/developer.texi
@@ -421,35 +421,6 @@ finding a new maintainer and also don't forget to update the @file{MAINTAINERS}
We think our rules are not too hard. If you have comments, contact us.
- at chapter Code of conduct
-
-Be friendly and respectful towards others and third parties.
-Treat others the way you yourself want to be treated.
-
-Be considerate. Not everyone shares the same viewpoint and priorities as you do.
-Different opinions and interpretations help the project.
-Looking at issues from a different perspective assists development.
-
-Do not assume malice for things that can be attributed to incompetence. Even if
-it is malice, it's rarely good to start with that as initial assumption.
-
-Stay friendly even if someone acts contrarily. Everyone has a bad day
-once in a while.
-If you yourself have a bad day or are angry then try to take a break and reply
-once you are calm and without anger if you have to.
-
-Try to help other team members and cooperate if you can.
-
-The goal of software development is to create technical excellence, not for any
-individual to be better and "win" against the others. Large software projects
-are only possible and successful through teamwork.
-
-If someone struggles do not put them down. Give them a helping hand
-instead and point them in the right direction.
-
-Finally, keep in mind the immortal words of Bill and Ted,
-"Be excellent to each other."
-
@anchor{Submitting patches}
@chapter Submitting patches
diff --git a/doc/mailing-list-faq.texi b/doc/mailing-list-faq.texi
index 534ef3f802..b2028eeee1 100644
--- a/doc/mailing-list-faq.texi
+++ b/doc/mailing-list-faq.texi
@@ -344,7 +344,7 @@ recommended.
Avoid sending the same message to multiple mailing lists.
@item
-Please follow our @url{https://ffmpeg.org/developer.html#Code-of-conduct, Code of Conduct}.
+Please follow our @url{https://ffmpeg.org/community.html#Code-of-conduct, Code of Conduct}.
@end itemize
@chapter Help
--
2.20.1 (Apple Git-117)
More information about the ffmpeg-devel
mailing list