Browse Source

Split up contributing section into GitHub's format

This integrates better with the GitHub UI.
Eloston 5 years ago
parent
commit
9bd021519c
3 changed files with 65 additions and 52 deletions
  1. 3 52
      README.md
  2. 15 0
      SUPPORT.md
  3. 47 0
      docs/contributing.md

+ 3 - 52
README.md

@@ -18,7 +18,7 @@ From a technical standpoint, ungoogled-chromium is a set of configuration flags,
 
 Since these goals and requirements are not precise, unclear situations are discussed and decided on a case-by-case basis.
 
-**ungoogled-chromium always welcomes more help!** See the [Contributing, Reporting, Contacting](#contributing-reporting-contacting) section for more information.
+**ungoogled-chromium always welcomes more help!** See the [docs/contributing.md](docs/contributing.md) document for more information.
 
 ## Table of Contents
 
@@ -30,9 +30,6 @@ Since these goals and requirements are not precise, unclear situations are discu
 * [Design and implementation](#design-and-implementation)
 * [Building](#building)
 * [**Contributing, Reporting, Contacting**](#contributing-reporting-contacting)
-    * [How to help](#how-to-help)
-    * [Submitting changes](#submitting-changes)
-    * [Criteria for new features](#criteria-for-new-features)
 * [Credits](#credits)
 * [License](#license)
 
@@ -127,54 +124,8 @@ Not all tags are stable for all platforms. See the [Statuses in the Wiki](//ungo
 
 ## Contributing, Reporting, Contacting
 
-Please submit feedback (i.e. problems, suggestions, and questions) to the [Issue Tracker](//github.com/Eloston/ungoogled-chromium/issues). The Issue Tracker is the main hub for development activity.
-
-There are chat room options available via [Gitter](https://gitter.im/ungoogled-software/Lobby) and Matrix.org (name `ungoogled-software/lobby`, which has bidirectional connection with Gitter). They are optional; it is only provided for those who prefer this format.
-
-Subsections of this section:
-
-* [How to help](#how-to-help)
-* [Submitting changes](#submitting-changes)
-* [Criteria for new features](#criteria-for-new-features)
-
-### How to help
-
-Generally, ungoogled-chromium needs maintainers to help:
-
-* Keep up-to-date with the latest stable Chromium, and any problematic changes in the new version that needs modification.
-* Implement feature requests ("enhancements" in the Issue Tracker), large or small.
-
-In addition, anyone is free to help others in need of support in the Issue Tracker.
-
-Issues marked with the `help wanted` tag are changes that needs discussion or assistance.
-
-* If it requires new code, please read through the [Submitting changes](#submitting-changes) section below.
-* If you want to work on an issue, please state your intent to do so first to let others know.
-
-If there are fixes, tweaks, or additions you want to make, continue onto the following section.
-
-### Submitting changes
-
-Please submit all changes via Pull Requests.
-
-Guidelines:
-
-* You are welcome to submit minor changes, such as bug fixes, documentation fixes, and tweaks.
-* If you want to submit a new feature, please read through the [Criteria for new features](#criteria-for-new-features) below.
-* When in doubt about the acceptance of a change, you are welcome to ask via an issue first.
-
-### Criteria for new features
-
-1. New features should not detract from the default Chromium experience, unless it falls under the project's main objectives (i.e. removing Google integration and enhancing privacy).
-
-    * For larger features, please propose them via an issue first.
-
-2. New features should live behind a setting that is **off by default**.
-
-    * Settings are usually added via a command-line flag and `chrome://flags` entries. See [the relevant section in docs/developing.md](docs/developing.md#adding-command-line-flags-and-chromeflags-options) for more information.
-    * Unless there are significant benefits, adding the setting to `chrome://settings` is *not recommended* due to the additional maintenance required (caused by the infrastructure that backs preferences).
-
-**NOTE**: In the event that the codebase changes significantly for a non-essential patch (i.e. a patch that does not contribute to the main objectives of ungoogled-chromium), it will be removed until someone updates it.
+* For reporting and contating, see [SUPPORT.md](SUPPORT.md)
+* For contributing (e.g. how to help, submitting changes, criteria for new features), see [docs/contributing.md](docs/contributing.md)
 
 ## Credits
 

+ 15 - 0
SUPPORT.md

@@ -0,0 +1,15 @@
+# Support
+
+**Before you submit feedback, please ensure you have tried the following**: 
+
+* Read the [FAQ](//ungoogled-software.github.io/ungoogled-chromium-wiki/faq)
+* Check if your feedback already exists in the [Issue Tracker](//github.com/Eloston/ungoogled-chromium/issues) (make sure to search closed issues and use search filters, as applicable)
+* If this is a problem, ensure it does *not* occur with regular Chromium or Google Chrome. If it does, then this is *not* a problem with ungoogled-chromium. Instead, please submit your feedback to the [Chromium bug tracker](//bugs.chromium.org/p/chromium/issues/list) or Google.
+* Read the documentation under [docs/](docs/)
+
+There are two channels for support:
+
+* The [Issue Tracker](//github.com/Eloston/ungoogled-chromium/issues). The Issue Tracker is the main hub for discussions and development activity, and thus the primary means of support. It includes problems, suggestions, and questions.
+* A chat room. There are two options available:
+    * [Gitter](https://gitter.im/ungoogled-software/Lobby). It can use your GitHub account as an identity.
+    * Matrix.org under name `ungoogled-software/lobby`. It has a bidirectional connection with Gitter.

+ 47 - 0
docs/contributing.md

@@ -0,0 +1,47 @@
+# Contributing
+
+Subsections of this section:
+
+* [How to help](#how-to-help)
+* [Submitting changes](#submitting-changes)
+* [Criteria for new features](#criteria-for-new-features)
+
+### How to help
+
+Generally, ungoogled-chromium needs maintainers to help:
+
+* Keep up-to-date with the latest stable Chromium, and any problematic changes in the new version that needs modification.
+* Implement feature requests ("enhancements" in the Issue Tracker), large or small.
+
+In addition, anyone is free to help others in need of support in the Issue Tracker.
+
+Issues marked with the `help wanted` tag are changes that needs discussion or assistance.
+
+* If it requires new code, please read through the [Submitting changes](#submitting-changes) section below.
+* If you want to work on an issue, please state your intent to do so first to let others know.
+
+If there are fixes, tweaks, or additions you want to make, continue onto the following section.
+
+### Submitting changes
+
+Please submit all changes via Pull Requests.
+
+Guidelines:
+
+* You are welcome to submit minor changes, such as bug fixes, documentation fixes, and tweaks.
+* If you want to submit a new feature, please read through the [Criteria for new features](#criteria-for-new-features) below.
+* When in doubt about the acceptance of a change, you are welcome to ask via an issue first.
+
+### Criteria for new features
+
+1. New features should not detract from the default Chromium experience, unless it falls under the project's main objectives (i.e. removing Google integration and enhancing privacy).
+
+    * For larger features, please propose them via an issue first.
+
+2. New features should live behind a setting that is **off by default**.
+
+    * Settings are usually added via a command-line flag and `chrome://flags` entries. See [the relevant section in docs/developing.md](docs/developing.md#adding-command-line-flags-and-chromeflags-options) for more information.
+    * Unless there are significant benefits, adding the setting to `chrome://settings` is *not recommended* due to the additional maintenance required (caused by the infrastructure that backs preferences).
+
+**NOTE**: In the event that the codebase changes significantly for a non-essential patch (i.e. a patch that does not contribute to the main objectives of ungoogled-chromium), it will be removed until someone updates it.
+