mirror of
https://github.com/hyprwm/RFCs.git
synced 2024-12-04 20:15:58 +01:00
Initialize RFC process
This commit is contained in:
parent
da646e7a66
commit
55385d2bb3
4 changed files with 723 additions and 1 deletions
428
LICENSE
Normal file
428
LICENSE
Normal file
|
@ -0,0 +1,428 @@
|
||||||
|
Attribution-ShareAlike 4.0 International
|
||||||
|
|
||||||
|
=======================================================================
|
||||||
|
|
||||||
|
Creative Commons Corporation ("Creative Commons") is not a law firm and
|
||||||
|
does not provide legal services or legal advice. Distribution of
|
||||||
|
Creative Commons public licenses does not create a lawyer-client or
|
||||||
|
other relationship. Creative Commons makes its licenses and related
|
||||||
|
information available on an "as-is" basis. Creative Commons gives no
|
||||||
|
warranties regarding its licenses, any material licensed under their
|
||||||
|
terms and conditions, or any related information. Creative Commons
|
||||||
|
disclaims all liability for damages resulting from their use to the
|
||||||
|
fullest extent possible.
|
||||||
|
|
||||||
|
Using Creative Commons Public Licenses
|
||||||
|
|
||||||
|
Creative Commons public licenses provide a standard set of terms and
|
||||||
|
conditions that creators and other rights holders may use to share
|
||||||
|
original works of authorship and other material subject to copyright
|
||||||
|
and certain other rights specified in the public license below. The
|
||||||
|
following considerations are for informational purposes only, are not
|
||||||
|
exhaustive, and do not form part of our licenses.
|
||||||
|
|
||||||
|
Considerations for licensors: Our public licenses are
|
||||||
|
intended for use by those authorized to give the public
|
||||||
|
permission to use material in ways otherwise restricted by
|
||||||
|
copyright and certain other rights. Our licenses are
|
||||||
|
irrevocable. Licensors should read and understand the terms
|
||||||
|
and conditions of the license they choose before applying it.
|
||||||
|
Licensors should also secure all rights necessary before
|
||||||
|
applying our licenses so that the public can reuse the
|
||||||
|
material as expected. Licensors should clearly mark any
|
||||||
|
material not subject to the license. This includes other CC-
|
||||||
|
licensed material, or material used under an exception or
|
||||||
|
limitation to copyright. More considerations for licensors:
|
||||||
|
wiki.creativecommons.org/Considerations_for_licensors
|
||||||
|
|
||||||
|
Considerations for the public: By using one of our public
|
||||||
|
licenses, a licensor grants the public permission to use the
|
||||||
|
licensed material under specified terms and conditions. If
|
||||||
|
the licensor's permission is not necessary for any reason--for
|
||||||
|
example, because of any applicable exception or limitation to
|
||||||
|
copyright--then that use is not regulated by the license. Our
|
||||||
|
licenses grant only permissions under copyright and certain
|
||||||
|
other rights that a licensor has authority to grant. Use of
|
||||||
|
the licensed material may still be restricted for other
|
||||||
|
reasons, including because others have copyright or other
|
||||||
|
rights in the material. A licensor may make special requests,
|
||||||
|
such as asking that all changes be marked or described.
|
||||||
|
Although not required by our licenses, you are encouraged to
|
||||||
|
respect those requests where reasonable. More_considerations
|
||||||
|
for the public:
|
||||||
|
wiki.creativecommons.org/Considerations_for_licensees
|
||||||
|
|
||||||
|
=======================================================================
|
||||||
|
|
||||||
|
Creative Commons Attribution-ShareAlike 4.0 International Public
|
||||||
|
License
|
||||||
|
|
||||||
|
By exercising the Licensed Rights (defined below), You accept and agree
|
||||||
|
to be bound by the terms and conditions of this Creative Commons
|
||||||
|
Attribution-ShareAlike 4.0 International Public License ("Public
|
||||||
|
License"). To the extent this Public License may be interpreted as a
|
||||||
|
contract, You are granted the Licensed Rights in consideration of Your
|
||||||
|
acceptance of these terms and conditions, and the Licensor grants You
|
||||||
|
such rights in consideration of benefits the Licensor receives from
|
||||||
|
making the Licensed Material available under these terms and
|
||||||
|
conditions.
|
||||||
|
|
||||||
|
|
||||||
|
Section 1 -- Definitions.
|
||||||
|
|
||||||
|
a. Adapted Material means material subject to Copyright and Similar
|
||||||
|
Rights that is derived from or based upon the Licensed Material
|
||||||
|
and in which the Licensed Material is translated, altered,
|
||||||
|
arranged, transformed, or otherwise modified in a manner requiring
|
||||||
|
permission under the Copyright and Similar Rights held by the
|
||||||
|
Licensor. For purposes of this Public License, where the Licensed
|
||||||
|
Material is a musical work, performance, or sound recording,
|
||||||
|
Adapted Material is always produced where the Licensed Material is
|
||||||
|
synched in timed relation with a moving image.
|
||||||
|
|
||||||
|
b. Adapter's License means the license You apply to Your Copyright
|
||||||
|
and Similar Rights in Your contributions to Adapted Material in
|
||||||
|
accordance with the terms and conditions of this Public License.
|
||||||
|
|
||||||
|
c. BY-SA Compatible License means a license listed at
|
||||||
|
creativecommons.org/compatiblelicenses, approved by Creative
|
||||||
|
Commons as essentially the equivalent of this Public License.
|
||||||
|
|
||||||
|
d. Copyright and Similar Rights means copyright and/or similar rights
|
||||||
|
closely related to copyright including, without limitation,
|
||||||
|
performance, broadcast, sound recording, and Sui Generis Database
|
||||||
|
Rights, without regard to how the rights are labeled or
|
||||||
|
categorized. For purposes of this Public License, the rights
|
||||||
|
specified in Section 2(b)(1)-(2) are not Copyright and Similar
|
||||||
|
Rights.
|
||||||
|
|
||||||
|
e. Effective Technological Measures means those measures that, in the
|
||||||
|
absence of proper authority, may not be circumvented under laws
|
||||||
|
fulfilling obligations under Article 11 of the WIPO Copyright
|
||||||
|
Treaty adopted on December 20, 1996, and/or similar international
|
||||||
|
agreements.
|
||||||
|
|
||||||
|
f. Exceptions and Limitations means fair use, fair dealing, and/or
|
||||||
|
any other exception or limitation to Copyright and Similar Rights
|
||||||
|
that applies to Your use of the Licensed Material.
|
||||||
|
|
||||||
|
g. License Elements means the license attributes listed in the name
|
||||||
|
of a Creative Commons Public License. The License Elements of this
|
||||||
|
Public License are Attribution and ShareAlike.
|
||||||
|
|
||||||
|
h. Licensed Material means the artistic or literary work, database,
|
||||||
|
or other material to which the Licensor applied this Public
|
||||||
|
License.
|
||||||
|
|
||||||
|
i. Licensed Rights means the rights granted to You subject to the
|
||||||
|
terms and conditions of this Public License, which are limited to
|
||||||
|
all Copyright and Similar Rights that apply to Your use of the
|
||||||
|
Licensed Material and that the Licensor has authority to license.
|
||||||
|
|
||||||
|
j. Licensor means the individual(s) or entity(ies) granting rights
|
||||||
|
under this Public License.
|
||||||
|
|
||||||
|
k. Share means to provide material to the public by any means or
|
||||||
|
process that requires permission under the Licensed Rights, such
|
||||||
|
as reproduction, public display, public performance, distribution,
|
||||||
|
dissemination, communication, or importation, and to make material
|
||||||
|
available to the public including in ways that members of the
|
||||||
|
public may access the material from a place and at a time
|
||||||
|
individually chosen by them.
|
||||||
|
|
||||||
|
l. Sui Generis Database Rights means rights other than copyright
|
||||||
|
resulting from Directive 96/9/EC of the European Parliament and of
|
||||||
|
the Council of 11 March 1996 on the legal protection of databases,
|
||||||
|
as amended and/or succeeded, as well as other essentially
|
||||||
|
equivalent rights anywhere in the world.
|
||||||
|
|
||||||
|
m. You means the individual or entity exercising the Licensed Rights
|
||||||
|
under this Public License. Your has a corresponding meaning.
|
||||||
|
|
||||||
|
|
||||||
|
Section 2 -- Scope.
|
||||||
|
|
||||||
|
a. License grant.
|
||||||
|
|
||||||
|
1. Subject to the terms and conditions of this Public License,
|
||||||
|
the Licensor hereby grants You a worldwide, royalty-free,
|
||||||
|
non-sublicensable, non-exclusive, irrevocable license to
|
||||||
|
exercise the Licensed Rights in the Licensed Material to:
|
||||||
|
|
||||||
|
a. reproduce and Share the Licensed Material, in whole or
|
||||||
|
in part; and
|
||||||
|
|
||||||
|
b. produce, reproduce, and Share Adapted Material.
|
||||||
|
|
||||||
|
2. Exceptions and Limitations. For the avoidance of doubt, where
|
||||||
|
Exceptions and Limitations apply to Your use, this Public
|
||||||
|
License does not apply, and You do not need to comply with
|
||||||
|
its terms and conditions.
|
||||||
|
|
||||||
|
3. Term. The term of this Public License is specified in Section
|
||||||
|
6(a).
|
||||||
|
|
||||||
|
4. Media and formats; technical modifications allowed. The
|
||||||
|
Licensor authorizes You to exercise the Licensed Rights in
|
||||||
|
all media and formats whether now known or hereafter created,
|
||||||
|
and to make technical modifications necessary to do so. The
|
||||||
|
Licensor waives and/or agrees not to assert any right or
|
||||||
|
authority to forbid You from making technical modifications
|
||||||
|
necessary to exercise the Licensed Rights, including
|
||||||
|
technical modifications necessary to circumvent Effective
|
||||||
|
Technological Measures. For purposes of this Public License,
|
||||||
|
simply making modifications authorized by this Section 2(a)
|
||||||
|
(4) never produces Adapted Material.
|
||||||
|
|
||||||
|
5. Downstream recipients.
|
||||||
|
|
||||||
|
a. Offer from the Licensor -- Licensed Material. Every
|
||||||
|
recipient of the Licensed Material automatically
|
||||||
|
receives an offer from the Licensor to exercise the
|
||||||
|
Licensed Rights under the terms and conditions of this
|
||||||
|
Public License.
|
||||||
|
|
||||||
|
b. Additional offer from the Licensor -- Adapted Material.
|
||||||
|
Every recipient of Adapted Material from You
|
||||||
|
automatically receives an offer from the Licensor to
|
||||||
|
exercise the Licensed Rights in the Adapted Material
|
||||||
|
under the conditions of the Adapter's License You apply.
|
||||||
|
|
||||||
|
c. No downstream restrictions. You may not offer or impose
|
||||||
|
any additional or different terms or conditions on, or
|
||||||
|
apply any Effective Technological Measures to, the
|
||||||
|
Licensed Material if doing so restricts exercise of the
|
||||||
|
Licensed Rights by any recipient of the Licensed
|
||||||
|
Material.
|
||||||
|
|
||||||
|
6. No endorsement. Nothing in this Public License constitutes or
|
||||||
|
may be construed as permission to assert or imply that You
|
||||||
|
are, or that Your use of the Licensed Material is, connected
|
||||||
|
with, or sponsored, endorsed, or granted official status by,
|
||||||
|
the Licensor or others designated to receive attribution as
|
||||||
|
provided in Section 3(a)(1)(A)(i).
|
||||||
|
|
||||||
|
b. Other rights.
|
||||||
|
|
||||||
|
1. Moral rights, such as the right of integrity, are not
|
||||||
|
licensed under this Public License, nor are publicity,
|
||||||
|
privacy, and/or other similar personality rights; however, to
|
||||||
|
the extent possible, the Licensor waives and/or agrees not to
|
||||||
|
assert any such rights held by the Licensor to the limited
|
||||||
|
extent necessary to allow You to exercise the Licensed
|
||||||
|
Rights, but not otherwise.
|
||||||
|
|
||||||
|
2. Patent and trademark rights are not licensed under this
|
||||||
|
Public License.
|
||||||
|
|
||||||
|
3. To the extent possible, the Licensor waives any right to
|
||||||
|
collect royalties from You for the exercise of the Licensed
|
||||||
|
Rights, whether directly or through a collecting society
|
||||||
|
under any voluntary or waivable statutory or compulsory
|
||||||
|
licensing scheme. In all other cases the Licensor expressly
|
||||||
|
reserves any right to collect such royalties.
|
||||||
|
|
||||||
|
|
||||||
|
Section 3 -- License Conditions.
|
||||||
|
|
||||||
|
Your exercise of the Licensed Rights is expressly made subject to the
|
||||||
|
following conditions.
|
||||||
|
|
||||||
|
a. Attribution.
|
||||||
|
|
||||||
|
1. If You Share the Licensed Material (including in modified
|
||||||
|
form), You must:
|
||||||
|
|
||||||
|
a. retain the following if it is supplied by the Licensor
|
||||||
|
with the Licensed Material:
|
||||||
|
|
||||||
|
i. identification of the creator(s) of the Licensed
|
||||||
|
Material and any others designated to receive
|
||||||
|
attribution, in any reasonable manner requested by
|
||||||
|
the Licensor (including by pseudonym if
|
||||||
|
designated);
|
||||||
|
|
||||||
|
ii. a copyright notice;
|
||||||
|
|
||||||
|
iii. a notice that refers to this Public License;
|
||||||
|
|
||||||
|
iv. a notice that refers to the disclaimer of
|
||||||
|
warranties;
|
||||||
|
|
||||||
|
v. a URI or hyperlink to the Licensed Material to the
|
||||||
|
extent reasonably practicable;
|
||||||
|
|
||||||
|
b. indicate if You modified the Licensed Material and
|
||||||
|
retain an indication of any previous modifications; and
|
||||||
|
|
||||||
|
c. indicate the Licensed Material is licensed under this
|
||||||
|
Public License, and include the text of, or the URI or
|
||||||
|
hyperlink to, this Public License.
|
||||||
|
|
||||||
|
2. You may satisfy the conditions in Section 3(a)(1) in any
|
||||||
|
reasonable manner based on the medium, means, and context in
|
||||||
|
which You Share the Licensed Material. For example, it may be
|
||||||
|
reasonable to satisfy the conditions by providing a URI or
|
||||||
|
hyperlink to a resource that includes the required
|
||||||
|
information.
|
||||||
|
|
||||||
|
3. If requested by the Licensor, You must remove any of the
|
||||||
|
information required by Section 3(a)(1)(A) to the extent
|
||||||
|
reasonably practicable.
|
||||||
|
|
||||||
|
b. ShareAlike.
|
||||||
|
|
||||||
|
In addition to the conditions in Section 3(a), if You Share
|
||||||
|
Adapted Material You produce, the following conditions also apply.
|
||||||
|
|
||||||
|
1. The Adapter's License You apply must be a Creative Commons
|
||||||
|
license with the same License Elements, this version or
|
||||||
|
later, or a BY-SA Compatible License.
|
||||||
|
|
||||||
|
2. You must include the text of, or the URI or hyperlink to, the
|
||||||
|
Adapter's License You apply. You may satisfy this condition
|
||||||
|
in any reasonable manner based on the medium, means, and
|
||||||
|
context in which You Share Adapted Material.
|
||||||
|
|
||||||
|
3. You may not offer or impose any additional or different terms
|
||||||
|
or conditions on, or apply any Effective Technological
|
||||||
|
Measures to, Adapted Material that restrict exercise of the
|
||||||
|
rights granted under the Adapter's License You apply.
|
||||||
|
|
||||||
|
|
||||||
|
Section 4 -- Sui Generis Database Rights.
|
||||||
|
|
||||||
|
Where the Licensed Rights include Sui Generis Database Rights that
|
||||||
|
apply to Your use of the Licensed Material:
|
||||||
|
|
||||||
|
a. for the avoidance of doubt, Section 2(a)(1) grants You the right
|
||||||
|
to extract, reuse, reproduce, and Share all or a substantial
|
||||||
|
portion of the contents of the database;
|
||||||
|
|
||||||
|
b. if You include all or a substantial portion of the database
|
||||||
|
contents in a database in which You have Sui Generis Database
|
||||||
|
Rights, then the database in which You have Sui Generis Database
|
||||||
|
Rights (but not its individual contents) is Adapted Material,
|
||||||
|
|
||||||
|
including for purposes of Section 3(b); and
|
||||||
|
c. You must comply with the conditions in Section 3(a) if You Share
|
||||||
|
all or a substantial portion of the contents of the database.
|
||||||
|
|
||||||
|
For the avoidance of doubt, this Section 4 supplements and does not
|
||||||
|
replace Your obligations under this Public License where the Licensed
|
||||||
|
Rights include other Copyright and Similar Rights.
|
||||||
|
|
||||||
|
|
||||||
|
Section 5 -- Disclaimer of Warranties and Limitation of Liability.
|
||||||
|
|
||||||
|
a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE
|
||||||
|
EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS
|
||||||
|
AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF
|
||||||
|
ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS,
|
||||||
|
IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION,
|
||||||
|
WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS,
|
||||||
|
ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT
|
||||||
|
KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT
|
||||||
|
ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU.
|
||||||
|
|
||||||
|
b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE
|
||||||
|
TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,
|
||||||
|
NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT,
|
||||||
|
INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES,
|
||||||
|
COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR
|
||||||
|
USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN
|
||||||
|
ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR
|
||||||
|
DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR
|
||||||
|
IN PART, THIS LIMITATION MAY NOT APPLY TO YOU.
|
||||||
|
|
||||||
|
c. The disclaimer of warranties and limitation of liability provided
|
||||||
|
above shall be interpreted in a manner that, to the extent
|
||||||
|
possible, most closely approximates an absolute disclaimer and
|
||||||
|
waiver of all liability.
|
||||||
|
|
||||||
|
|
||||||
|
Section 6 -- Term and Termination.
|
||||||
|
|
||||||
|
a. This Public License applies for the term of the Copyright and
|
||||||
|
Similar Rights licensed here. However, if You fail to comply with
|
||||||
|
this Public License, then Your rights under this Public License
|
||||||
|
terminate automatically.
|
||||||
|
|
||||||
|
b. Where Your right to use the Licensed Material has terminated under
|
||||||
|
Section 6(a), it reinstates:
|
||||||
|
|
||||||
|
1. automatically as of the date the violation is cured, provided
|
||||||
|
it is cured within 30 days of Your discovery of the
|
||||||
|
violation; or
|
||||||
|
|
||||||
|
2. upon express reinstatement by the Licensor.
|
||||||
|
|
||||||
|
For the avoidance of doubt, this Section 6(b) does not affect any
|
||||||
|
right the Licensor may have to seek remedies for Your violations
|
||||||
|
of this Public License.
|
||||||
|
|
||||||
|
c. For the avoidance of doubt, the Licensor may also offer the
|
||||||
|
Licensed Material under separate terms or conditions or stop
|
||||||
|
distributing the Licensed Material at any time; however, doing so
|
||||||
|
will not terminate this Public License.
|
||||||
|
|
||||||
|
d. Sections 1, 5, 6, 7, and 8 survive termination of this Public
|
||||||
|
License.
|
||||||
|
|
||||||
|
|
||||||
|
Section 7 -- Other Terms and Conditions.
|
||||||
|
|
||||||
|
a. The Licensor shall not be bound by any additional or different
|
||||||
|
terms or conditions communicated by You unless expressly agreed.
|
||||||
|
|
||||||
|
b. Any arrangements, understandings, or agreements regarding the
|
||||||
|
Licensed Material not stated herein are separate from and
|
||||||
|
independent of the terms and conditions of this Public License.
|
||||||
|
|
||||||
|
|
||||||
|
Section 8 -- Interpretation.
|
||||||
|
|
||||||
|
a. For the avoidance of doubt, this Public License does not, and
|
||||||
|
shall not be interpreted to, reduce, limit, restrict, or impose
|
||||||
|
conditions on any use of the Licensed Material that could lawfully
|
||||||
|
be made without permission under this Public License.
|
||||||
|
|
||||||
|
b. To the extent possible, if any provision of this Public License is
|
||||||
|
deemed unenforceable, it shall be automatically reformed to the
|
||||||
|
minimum extent necessary to make it enforceable. If the provision
|
||||||
|
cannot be reformed, it shall be severed from this Public License
|
||||||
|
without affecting the enforceability of the remaining terms and
|
||||||
|
conditions.
|
||||||
|
|
||||||
|
c. No term or condition of this Public License will be waived and no
|
||||||
|
failure to comply consented to unless expressly agreed to by the
|
||||||
|
Licensor.
|
||||||
|
|
||||||
|
d. Nothing in this Public License constitutes or may be interpreted
|
||||||
|
as a limitation upon, or waiver of, any privileges and immunities
|
||||||
|
that apply to the Licensor or You, including from the legal
|
||||||
|
processes of any jurisdiction or authority.
|
||||||
|
|
||||||
|
|
||||||
|
=======================================================================
|
||||||
|
|
||||||
|
Creative Commons is not a party to its public
|
||||||
|
licenses. Notwithstanding, Creative Commons may elect to apply one of
|
||||||
|
its public licenses to material it publishes and in those instances
|
||||||
|
will be considered the “Licensor.” The text of the Creative Commons
|
||||||
|
public licenses is dedicated to the public domain under the CC0 Public
|
||||||
|
Domain Dedication. Except for the limited purpose of indicating that
|
||||||
|
material is shared under a Creative Commons public license or as
|
||||||
|
otherwise permitted by the Creative Commons policies published at
|
||||||
|
creativecommons.org/policies, Creative Commons does not authorize the
|
||||||
|
use of the trademark "Creative Commons" or any other trademark or logo
|
||||||
|
of Creative Commons without its prior written consent including,
|
||||||
|
without limitation, in connection with any unauthorized modifications
|
||||||
|
to any of its public licenses or any other arrangements,
|
||||||
|
understandings, or agreements concerning use of licensed material. For
|
||||||
|
the avoidance of doubt, this paragraph does not form part of the
|
||||||
|
public licenses.
|
||||||
|
|
||||||
|
Creative Commons may be contacted at creativecommons.org.
|
||||||
|
|
296
README.md
296
README.md
|
@ -1 +1,295 @@
|
||||||
# RFCs
|
# HyprWM RFCs (Request for Comments)
|
||||||
|
|
||||||
|
Welcome to the RFC (Request for Comments) repository for HyprWM. Here you may
|
||||||
|
propose, discuss and track changes to various aspects of the HyprWM organization
|
||||||
|
including, but not limited to, community structure, project features, packaging
|
||||||
|
and security of projects.
|
||||||
|
|
||||||
|
## What is an RFC?
|
||||||
|
|
||||||
|
RFC stands for Request for Comments. It's a formalized way to propose
|
||||||
|
significant changes, new features, or enhancements to a project. The purpose of
|
||||||
|
an RFC is to solicit feedback and build consensus around proposed changes before
|
||||||
|
they are implemented.
|
||||||
|
|
||||||
|
## Motivation
|
||||||
|
|
||||||
|
The purpose of the RFC process is to provide a structured and collaborative
|
||||||
|
process for proposing and discussing significant changes, new feature additions
|
||||||
|
or enhancements to HyprWM projects. By implementing and normalizing the RFC
|
||||||
|
process, we aim to:
|
||||||
|
|
||||||
|
- Encourage participation: Provide a platform for all community members to
|
||||||
|
contribute ideas and feedback.
|
||||||
|
- Foster consensus: Facilitate discussions to build agreement and alignment
|
||||||
|
around proposed changes before they are implemented.
|
||||||
|
- Improve transparency: Document proposals, discussions, and decisions to keep
|
||||||
|
the community informed about the direction of HyprWM projects.
|
||||||
|
- Enhance quality: Ensure that proposed changes undergo proper review and
|
||||||
|
consideration alongside healthy communication before implementation, hopefully
|
||||||
|
leading to higher-quality outcomes than hastily done merges.
|
||||||
|
|
||||||
|
RFC documents are intended as the permanent documentation of a decision and a
|
||||||
|
snapshot of a moment in time, rather than a specification-like normative
|
||||||
|
document. The goal of the RFC process is to concentrate relevant discussion in
|
||||||
|
one location that can be easily archived and viewed.
|
||||||
|
|
||||||
|
## When this process is followed
|
||||||
|
|
||||||
|
The RFC process is followed when one intends to propose large changes to
|
||||||
|
projects under the HyprWM umbrella. The "large changes" in question may be
|
||||||
|
redefined in time, as the community evolves, but for the time being the
|
||||||
|
following are included:
|
||||||
|
|
||||||
|
- Broad changes to the documentation
|
||||||
|
- Semantic or syntactic changes to, e.g., Hyprlang
|
||||||
|
- Large restructures of the community mediums (Discord, Matrix, ...)
|
||||||
|
- Nix tooling and packaging
|
||||||
|
- Expansions of the scope of HyprWM (new projects, packaging, ...)
|
||||||
|
- Introduction of new interfaces to existing projects
|
||||||
|
|
||||||
|
Certain topics of interest, regardless of how many RFCs are submitted, will not
|
||||||
|
be subject to change:
|
||||||
|
|
||||||
|
- The project language (C++)
|
||||||
|
- The project owner ([@vaxerski](https://github.com/vaxerski))
|
||||||
|
|
||||||
|
Other changes, while difficult, may be subject to change if a compelling
|
||||||
|
argument is made:
|
||||||
|
|
||||||
|
- Build system (CMake)
|
||||||
|
- Wiki software
|
||||||
|
- Code style
|
||||||
|
|
||||||
|
## Glossary
|
||||||
|
|
||||||
|
### RFC Steering Committee
|
||||||
|
|
||||||
|
A group of members assigned by the
|
||||||
|
[Core HyprWM Team](https://github.com/orgs/hyprwm/teams/core) which would stay
|
||||||
|
consistent until the team composition is potentially changed through an RFC
|
||||||
|
proposal. This committee is tasked with forming an RFC Shepherd team from the
|
||||||
|
available nominations on each new RFC. The responsibilities of this team also
|
||||||
|
include naming a "leader" for the shepherd team during its life-cycle. This
|
||||||
|
**must** happen within 2 weeks after the Pull Request to the RFCs repository has
|
||||||
|
been opened. Until a leader has been assigned, the Steering Committee will also
|
||||||
|
be held responsible for guiding all discussions under the relevant pull request.
|
||||||
|
|
||||||
|
In case of the Shepherding Team not doing its work as expected, the Steering
|
||||||
|
Committee shall encourage them [to do so] or step in to assign a new Shepherd
|
||||||
|
team that may or may not include previous teams. They will also be in charge of
|
||||||
|
marking the end of an RFC discussion period (i.e. merging or rejecting) the RFC.
|
||||||
|
|
||||||
|
Current RFC Steering Committee consists of:
|
||||||
|
|
||||||
|
- TBD
|
||||||
|
- TBD
|
||||||
|
- TBD
|
||||||
|
- ...
|
||||||
|
|
||||||
|
### Shepherd Team
|
||||||
|
|
||||||
|
A team of 2-4 community members, defined unanimously by the RFC Steering
|
||||||
|
Committee, tasked with marking the end of an RFC's life-cycle by marking it for
|
||||||
|
either merge or rejection. This team is formed during each RFC's life-cycle, and
|
||||||
|
for the relevant RFC only from community members nominated in the discussion of
|
||||||
|
that RFC.
|
||||||
|
|
||||||
|
This team shall be people who are very familiar with the components that are the
|
||||||
|
main subjects of the RFC, and the author may not be a part of the Shepherd Team.
|
||||||
|
In addition to the previous restrictions, at least one and at most half of the
|
||||||
|
Shepherd Team shall be part of the RFC Steering Committee.
|
||||||
|
|
||||||
|
The responsibility of the team is to guide and moderate the discussion as long
|
||||||
|
as it is constructive, brings new points to the table and while the RFC is
|
||||||
|
iterated and circled-back to from time to time. If this is no longer the case,
|
||||||
|
the Shepherd Team shall decide on whether to proceed with the FCP.
|
||||||
|
|
||||||
|
#### Shepherd Leader
|
||||||
|
|
||||||
|
The Shepherd Leader refers to the person in charge of the RFC process for a
|
||||||
|
specific RFC, with the responsibility of ensuring that the process is followed
|
||||||
|
in a neat, timely and civil fashion. This person has no special responsibility
|
||||||
|
with regard to moving an undecided Shepherd Team to a certain decision.
|
||||||
|
|
||||||
|
### Final Comment Period (FCP)
|
||||||
|
|
||||||
|
A period of 8 calendar days, which will be called by the Shepherd Team after the
|
||||||
|
RFC has received the proper amount of discussion appropriate to the size of the
|
||||||
|
RFC, and enough of the pros and cons of said RFC have been discussed. The
|
||||||
|
Shepherd Team will propose to either accept, or reject the RFC once the FCP
|
||||||
|
period is concluded.
|
||||||
|
|
||||||
|
## Process from Creation to Merge
|
||||||
|
|
||||||
|
_In short, to get a major change propagated to the HyprWM organization or to a
|
||||||
|
project under the HyprWM organization, one must first get an RFC merged into the
|
||||||
|
RFC repository as a markdown file under the `rfcs` directory, with the file name
|
||||||
|
`XXXX-<name>.md` where the `XXXX` in the name stands for the RFC number,
|
||||||
|
starting from `0000` At that point the RFC is accepted, and may be implemented
|
||||||
|
with the goal of eventual inclusion into HyprWM or a project under the HyprWM
|
||||||
|
organization._
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
<img src="./assets/rfc-process.png" alt="RFC Process">
|
||||||
|
</div>
|
||||||
|
|
||||||
|
1. Have a cool idea!
|
||||||
|
2. Fill in the RFC. Put good care into details: RFCs that do not present
|
||||||
|
convincing motivation, demonstrate understanding of the impact of proposed
|
||||||
|
change or are disingenuous about the drawbacks or alternatives may be poorly
|
||||||
|
received, or vetoed.
|
||||||
|
3. In case your RFC is a technical proposal, consider preparing a prototype that
|
||||||
|
visualizes your idea for potential shepherd and bystanders. It will also help
|
||||||
|
you catch any pitfalls your idea might have stumbled upon.
|
||||||
|
4. Submit a pull request. The RFC will receive feedback on its design and
|
||||||
|
implementation from the larger community, therefore the author must be
|
||||||
|
prepared to amend and revise if necessary.
|
||||||
|
5. For the nomination process for potential members of the RFC Shepherd Team
|
||||||
|
that is exclusive to each RFC, anyone interested can either nominate another
|
||||||
|
person who is willing or themselves to be a potential member of the RFC
|
||||||
|
Shepherd team. This can already be done when submitting the PR, with a
|
||||||
|
pre-formed Shepherd team.
|
||||||
|
6. The RFC Steering Committee assigns a subset of nominees to the RFC Shepherd
|
||||||
|
Team and assigns a designated leader to it. This has to be done unanimously,
|
||||||
|
and is considered a blocker. The RFC may be on hold until a leader is
|
||||||
|
assigned.
|
||||||
|
7. Consensus is built, and potential feedback is received by the RFC author.
|
||||||
|
RFCs that have broad support and consensus are much more likely to make
|
||||||
|
forward progress than those that do not receive any comments. Do feel free to
|
||||||
|
reach out to the RFC Shepherd Team leader in particular to get help
|
||||||
|
identifying stakeholders and obstacles.
|
||||||
|
8. The RFC Shepherd team will discuss the RFC pull request, as much as possible
|
||||||
|
in the comment thread of the pull request for the relevant RFC. Discussion
|
||||||
|
outside the pull request, either offline or in a video conference, that might
|
||||||
|
be preferable to get to a solution for complex issues, must be summarized by
|
||||||
|
the participants of said discussions in the pull request comment thread.
|
||||||
|
9. RFCs rarely go through without any changes, especially as alternatives and
|
||||||
|
drawbacks are pointed out. You may make edits, big or small, to the RFC in
|
||||||
|
order to clarify or change the proposed design. However, changes must be made
|
||||||
|
as new commits to the pull request, actively avoiding force pushes. On each
|
||||||
|
commit, leave a comment explaining your changes and your motivation for them.
|
||||||
|
Do not squash or rebase commits after they have been made visible once on the
|
||||||
|
pull request.
|
||||||
|
10. At some point, a member of the RFC Shepherd Team will propose to start the
|
||||||
|
"Final Comment Period" (FCP) on behalf of the team, along with a proposed
|
||||||
|
disposition for the RFC. This is usually one of "merge" or "close", and the
|
||||||
|
final decision is forwarded to the members of the Core Team who will either
|
||||||
|
**veto** the decision, or carry it out according to previous discussion.
|
||||||
|
|
||||||
|
- This step is taken when enough of the trade-offs and pitfalls have been
|
||||||
|
discussed that the RFC Shepherd team is in an appropriate position to make
|
||||||
|
a final decision. That does not require consensus amongst all participants
|
||||||
|
in the RFC thread (which is usually impossible). However, the argument
|
||||||
|
supporting the resulting disposition on the RFC needs to have already been
|
||||||
|
clearly articulated, and there should not be a strong consensus against
|
||||||
|
that position outside the RFC Shepherd Team. The RFC Shepherd Team members
|
||||||
|
are to use their best judgement in taking this steep, and the FCP itself
|
||||||
|
ensures there is ample time and notification for stakeholders to push back
|
||||||
|
if it is made prematurely.
|
||||||
|
|
||||||
|
- For RFCs with lengthy discussion, the motion to FCP is usually preceded by
|
||||||
|
a summary comment trying to lay out the current state of the discussion
|
||||||
|
and major trade-offs/points of disagreement.
|
||||||
|
|
||||||
|
- In order to actually enter FCP, it must be made clear that all members of
|
||||||
|
the RFC Shepherd team sign off the motion, e.g. through commits or
|
||||||
|
approvals, or a meeting protocol that has been recorded or transcribed.
|
||||||
|
|
||||||
|
11. The FCP is advertised widely by the Shepherds, most importantly on
|
||||||
|
officially endorsed social channels (e.g. Discord or Matrix). It lasts 8
|
||||||
|
calendar days starting with the announcement on the Pull Request (and the
|
||||||
|
subsequent Discord/Matrix announcement), so that it is open for at least 5
|
||||||
|
business days. This way, all stakeholders and community members a have a
|
||||||
|
chance to raise any final objections before a decision is reached.
|
||||||
|
12. In case of acceptance, the RFC Steering Committee merges the PR. Otherwise,
|
||||||
|
the RFC's pull request is closed by a Core Team member. If no consensus can
|
||||||
|
be reached on the RFC, but the idea in general is accepted, it gets closed,
|
||||||
|
too. A note is added that it should be proposed again, when the
|
||||||
|
circumstances that are preventing the discussion from coming to another
|
||||||
|
decision change.
|
||||||
|
13. If the RFC has been accepted, but a veto right is exercised by a Core Team
|
||||||
|
member, the RFC is invited to revise or to be resubmitted in the future by
|
||||||
|
the Core Team member. However, if the Core Team member thinks the interests
|
||||||
|
of HyprWM and the RFC author misalign, the RFC may be closed outright as per
|
||||||
|
the veto privilege.
|
||||||
|
|
||||||
|
<!--
|
||||||
|
Borrowed from https://github.com/NixOS/rfcs - It is modified to include the
|
||||||
|
veto process as well as other unhappy conditions.
|
||||||
|
|
||||||
|
This diagram is available under the CC-BY-SA 4.0 License as indicated
|
||||||
|
by the license section. Please see:
|
||||||
|
<https://github.com/NixOS/rfcs/?tab=readme-ov-file#license>
|
||||||
|
-->
|
||||||
|
<div align="center">
|
||||||
|
<img src="./assets/rfc-lifecycle.png" alt="RFC Life-cycle">
|
||||||
|
</div>
|
||||||
|
|
||||||
|
## Unhappy Cases
|
||||||
|
|
||||||
|
Ideally every RFC will complete review and be accepted or rejected.
|
||||||
|
Unfortunately, this can not always be the case. Below are the "Unhappy Cases" in
|
||||||
|
which your RFC will be held back, or closed.
|
||||||
|
|
||||||
|
### On Hold
|
||||||
|
|
||||||
|
If the author is unable or unwilling to update the RFC in a timely fashion they
|
||||||
|
may mark an RFC as "On Hold" to indicate that the RFC should not continue to be
|
||||||
|
pushed forward for the time being.
|
||||||
|
|
||||||
|
### Can't Find Shepherds
|
||||||
|
|
||||||
|
If an RFC that meet all prior conditions to move forward, but cannot establish a
|
||||||
|
team of members willing to Shepherd the RFC discussion (i.e. a Shepherd Team)
|
||||||
|
then the RFC will be put on hold for 30 days with the following message:
|
||||||
|
|
||||||
|
```
|
||||||
|
This RFC has acquired insufficient interest from the community. [A full
|
||||||
|
shepherd team is mandatory](https://github.com/hyprwm/RFCs/#shepherd-team)
|
||||||
|
for a RFC to move foward.
|
||||||
|
|
||||||
|
If not enough shepherds are found within the next month, this RFC will be closed
|
||||||
|
until enough participantss are found. The PR can be reopened at anytime if
|
||||||
|
enough shepherd nominations are made.
|
||||||
|
|
||||||
|
[Read more about the RFC process here](https://github.com/hyprwm/RFCs/blob/master/README.md)
|
||||||
|
```
|
||||||
|
|
||||||
|
If another month, starting from the sending of this message, passes and an RFC
|
||||||
|
team has not yet been formed, the pull request for the RFC will be closed with
|
||||||
|
the following message:
|
||||||
|
|
||||||
|
```
|
||||||
|
This RFC is being closed due to lack interest. If enough shepherds are found this
|
||||||
|
issue can be reopened. [Read more about the RFC process
|
||||||
|
here](https://github.com/hyprwm/RFCs/blob/master/README.md)
|
||||||
|
```
|
||||||
|
|
||||||
|
## The RFC life-cycle
|
||||||
|
|
||||||
|
Most RFCs describe changes that eventually need to be implemented, usually but
|
||||||
|
not necessarily in the form of a series of pull requests to one of the
|
||||||
|
repositories under the HyprWM organization. Ideally, an implementation or a
|
||||||
|
demonstration accompanies the initial RFC pull request when it is made. If
|
||||||
|
neither are present, the RFC author shall include a "roadmap" that describes the
|
||||||
|
order in which proposed changes will happen.
|
||||||
|
|
||||||
|
An RFC being marked as accepted shall not be seen as a rubber stamp, and in
|
||||||
|
particular still does not mean that the proposed changes will be made; it does
|
||||||
|
mean, however, in principle that all the major stakeholders have agreed to the
|
||||||
|
feature and are amenable to proceeding forward with it. In general though, the
|
||||||
|
"accepted" status means that the proposed changes are to be followed through
|
||||||
|
unless there are no substantial technical objections, or a veto from one of the
|
||||||
|
Core Team members.
|
||||||
|
|
||||||
|
It should be noted that the fact a given RFC has been accepted implies nothing
|
||||||
|
about what priority shall be assigned to its implementation unless that has been
|
||||||
|
explicitly stated in the RFC, and has been accepted by consensus. Authors shall
|
||||||
|
not expect that other project developers or team members will take on the
|
||||||
|
responsibility for implementing proposed changes.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
All contributions are licensed by their respective authors under the
|
||||||
|
[CC-BY-SA 4.0 License](https://creativecommons.org/licenses/by-sa/4.0/legalcode).
|
||||||
|
|
BIN
assets/rfc-lifecycle.png
Normal file
BIN
assets/rfc-lifecycle.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 65 KiB |
BIN
assets/rfc-process.png
Normal file
BIN
assets/rfc-process.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 22 KiB |
Loading…
Reference in a new issue