[gnome-control-center/gbsneto/communication-guidelines] docs: Document the Communication Guidelines



commit 31b90c33db723958cfe5f5d4e6c857f88c42cc4f
Author: Georges Basile Stavracas Neto <georges stavracas gmail com>
Date:   Mon Apr 1 17:33:00 2019 -0300

    docs: Document the Communication Guidelines
    
    These are the documented guidelines for when communicating
    and interacting with humans. Not following the documented
    guidelines means the comment will be removed, or the ticket
    will be closed.

 .gitlab/issue_templates/Bug.md     |  10 +++
 .gitlab/issue_templates/Feature.md |  10 +++
 README.md                          |  23 ++++---
 docs/CONTRIBUTING.md               | 137 ++++++++++++++++++++++++++++++++++++-
 4 files changed, 170 insertions(+), 10 deletions(-)
---
diff --git a/.gitlab/issue_templates/Bug.md b/.gitlab/issue_templates/Bug.md
index 416478e1d..1a3b131a2 100644
--- a/.gitlab/issue_templates/Bug.md
+++ b/.gitlab/issue_templates/Bug.md
@@ -1,3 +1,13 @@
+<!--
+
+Not following the communication guidelines [1] will mean your issue or comment
+will be removed. Read it carefully before submitting this issue.
+
+
+[1] 
https://gitlab.gnome.org/GNOME/gnome-control-center/blob/master/docs/CONTRIBUTING.md#communication-guideline
+
+ -->
+
 Detailed description of the issue. Put as much information as you can, potentially
 with images showing the issue.
 
diff --git a/.gitlab/issue_templates/Feature.md b/.gitlab/issue_templates/Feature.md
index d76486658..9959b0dad 100644
--- a/.gitlab/issue_templates/Feature.md
+++ b/.gitlab/issue_templates/Feature.md
@@ -1,3 +1,13 @@
+<!--
+
+Not following the communication guidelines [1] will mean your issue or comment
+will be removed. Read it carefully before submitting this issue.
+
+
+[1] 
https://gitlab.gnome.org/GNOME/gnome-control-center/blob/master/docs/CONTRIBUTING.md#communication-guideline
+
+ -->
+
 Detailed description of the feature. Put as much information as you can.
 
 Proposed Mockups:
diff --git a/README.md b/README.md
index 578c45756..74846e968 100644
--- a/README.md
+++ b/README.md
@@ -12,17 +12,10 @@ GNOME Settings is GNOME's main interface for configuration of various aspects of
 See `docs/CONTRIBUTING.md` for details on the contribution process, and `docs/HACKING.md`
 for the coding style guidelines.
 
-## Testing Unstable Settings
-
-It is quite easy to test and give feedback about the development version of GNOME
-Settings. Just access https://gitlab.gnome.org/GNOME/gnome-control-center/environments,
-get the latest version, download it, double-click the file, install and run.
-
-Note that GNOME Settings Flatpak will only work if you are running
-the latest GNOME version in your host system.
-
 ## Reporting Bugs
 
+Before reporting any bugs or opening feature requests, [read the communication 
guidelines][communication-guidelines].
+
 Bugs should be reported to the GNOME bug tracking system under the product
 gnome-control-center. It is available at [GitLab 
Issues](https://gitlab.gnome.org/GNOME/gnome-control-center/issues).
 
@@ -56,3 +49,15 @@ Reproduce the crash and when the program exits to (gdb) prompt, get the backtrac
 
 Once you have the backtrace, copy and paste it into the 'Comments' field or attach it as
 a file to the bug report.
+
+## Testing Unstable Settings
+
+It is quite easy to test and give feedback about the development version of GNOME
+Settings. Just access https://gitlab.gnome.org/GNOME/gnome-control-center/environments,
+get the latest version, download it, double-click the file, install and run.
+
+Note that GNOME Settings Flatpak will only work if you are running
+the latest GNOME version in your host system.
+
+
+[communication-guidelines]: 
https://gitlab.gnome.org/GNOME/gnome-control-center/blob/master/docs/CONTRIBUTING.md#communication-guidelines
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
index 58fca48c1..ed007eaaa 100644
--- a/docs/CONTRIBUTING.md
+++ b/docs/CONTRIBUTING.md
@@ -28,7 +28,8 @@ Please note we have a Code of Conduct, please follow it in all your interactions
 
 ## Code of Conduct
 
-GNOME Settings is a project developed based on GNOME Code of Conduct. You can read it below:
+GNOME Settings is a project developed based on GNOME Code of Conduct and GitHub's community
+guidelines. You can read it below:
 
 ### Summary
 
@@ -65,6 +66,140 @@ size, disability, ethnicity, gender identity and expression, level of experience
 nationality, personal appearance, race, religion, or sexual identity and
 orientation.
 
+### Communication Guidelines
+
+It is of ultimate importance to maintain a community where everyone is free to express themselves,
+review and comment on one another's ideas, both technical and otherwise. Such discussions, however,
+are unlikely to foster fruitful dialog when ideas are silenced because community members are being
+shouted down or are afraid to speak up.
+
+If you are external to the GNOME community, always keep the assimetry of communication in mind: while
+your interaction with community members (and in particular, maintainers and long-term contributors)
+may only take a moment, these members usually have to interact with a significantly higher number of
+people. Before writing a comment, opening a new issue, or engaging into any forum or IRC discussion,
+please take a moment to appreciate that fact.
+
+While communicating, it is expected that all involved members should be respectful and civil at all
+times, and refrain from attacking others on the basis of who they are.
+
+#### Communication Rules
+
+The following behaviors will not be tolerated on any occasion:
+
+ * **Threats of violence**: You may not threaten violence towards others or use the site to organize,
+   promote, or incite acts of real-world violence or terrorism. Think carefully about the words you
+   use, the images you post, and even the software you write, and how they may be interpreted by
+   others. Even if you mean something as a joke, it might not be received that way. If you think
+   that someone else might interpret the content you post as a threat, or as promoting violence or
+   terrorism, stop. Don't post it. In extraordinary cases, we may report threats of violence to law
+   enforcement if we think there may be a genuine risk of physical harm or a threat to public safety.
+
+ * **Hate speech and discrimination**: While it is not forbidden to broach topics such as age, body
+   size, disability, ethnicity, gender identity and expression, level of experience, nationality,
+   personal appearance, race, religion, or sexual identity and orientation, we do not tolerate
+   speech that attacks a person or group of people on the basis of who they are. Just realize that
+   when approached in an aggressive or insulting manner, these (and other) sensitive topics can make
+   others feel unwelcome, or perhaps even unsafe. While there's always the potential for
+   misunderstandings, we expect our community members to remain respectful and civil when discussing
+   sensitive topics.
+
+ * **Bullying and harassment**: We do not tolerate bullying or harassment. This means any habitual
+   badgering or intimidation targeted at a specific person or group of people. In general, if your
+   actions are unwanted and you continue to engage in them, there's a good chance you are headed
+   into bullying or harassment territory.
+
+ * **Impersonation**: You may not seek to mislead others as to your identity by copying another
+   person's avatar, posting content under their email address, using a similar username or otherwise
+   posing as someone else. Impersonation is a form of harassment.
+
+ * **Doxxing and invasion of privacy**: Don't post other people's personal information, such as
+   phone numbers, private email addresses, physical addresses, credit card numbers, Social
+   Security/National Identity numbers, or passwords. Depending on the context, such as in the case
+   of intimidation or harassment, we may consider other information, such as photos or videos that
+   were taken or distributed without the subject's consent, to be an invasion of privacy, especially
+   when such material presents a safety risk to the subject.
+
+ * **Obscene content**: Basically, don't post pornography, gore or any other depiction of violence.
+
+#### General Advices
+
+The following advices help increasing the efficiency of communication with community members:
+
+ * Do not post "me too" comments. Use the GitLab reactions instead.
+ * Avoid adding priority, time, or relevance hints if you are not involved with the development
+   of the application. For example, `This is an urgent issue` or `This should be fixed now` or even
+   `The majority of users need this feature`.
+ * Do not use act or write using passive-aggressive communication.
+ * When reporting technical problems with the application, such as misbehaviors or crashes, focus on
+   sharing as many details as possible, and avoid adding non-technical information to it. An example
+   of a **good** issue report:
+
+   ```
+   GNOME Settings crashes when opening the Wi-Fi panel with 3+ Wi-Fi adapters
+
+   Steps to reproduce (assuming 3+ Wi-Fi adapters are present):
+
+     1. Open GNOME Settings
+     2. Select the Wi-Fi panel
+     3. Observe the crash
+
+   This does not happen with 2 or less adapters. Here is a backtrace of the
+   crash: backtrace.txt
+   ```
+
+   In contrast, here is an example of a **bad** issue report:
+
+   ```
+   GNOME Settings crashed while I was trying to connect to the internet. How can such
+   a thing happen and nobody notice? Did you not test it before releasing it?
+
+   This should be fixed as quick as possible!
+   ```
+ * When asking for new features, try and add as many information to justify its relevance, why
+   should it not be implemented as an auxiliary program, what problems would it solve, and offer
+   suggestions about how you think it should be implemented. Example of a **good** feature request:
+
+   ```
+   GNOME Settings needs to expose IPv6 options
+
+   As of now, the connection editor dialog does not allow editing various IPv6
+   options. This is relevant because without some of these options, it is not
+   possible to have a valid IPv6 configuration and, consequently, not have access
+   to various websites and services.
+
+   The list of missing configurations that are essential is:
+
+    * <Feature A>
+    * <Feature B>
+
+   Optionally, the following configurations can also be added:
+
+    * <Feature C>
+    * <Feature D>
+
+   Here is a quick sketch I have made showing how I think these options
+   should be exposed as a user interface: sketch.png.
+   ```
+
+   Example of a **bad** feature request:
+
+   ```
+   Merge GNOME Tweaks in GNOME Settings
+
+   The options in GNOME Tweaks are absolutely essential to the majority of us
+   users. Why was it not merged already? This is an urgent issue and should
+   have been addressed years ago. You should allocate all your resources on
+   merging those two applications.
+   ```
+
+### What happens if someone breaks these rules or advices?
+
+Actions that may be taken in response to an abusive comment include but are not limited to:
+
+ * Content removal (when breaking any of the advices or rules)
+ * Content blocking (when breaking any of the advices or rules)
+ * Formal abuse report (when breaking any of the rules)
+
 ### Attribution
 
 This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]