[gnome-text-editor] be more explicit about design requirements
- From: Christian Hergert <chergert src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnome-text-editor] be more explicit about design requirements
- Date: Sun, 19 Jun 2022 17:12:11 +0000 (UTC)
commit 52d22172a4ae3b5276b36aae8f7d22a7a8744715
Author: Christian Hergert <chergert redhat com>
Date: Sun Jun 19 10:12:07 2022 -0700
be more explicit about design requirements
CONTRIBUTING.md | 8 ++++++++
README.md | 7 ++++++-
2 files changed, 14 insertions(+), 1 deletion(-)
---
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 8bd94ad..51c4f44 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -19,6 +19,14 @@ You can find mockups for Text Editor on the GNOME Design Team's
[https://gitlab.gnome.org/Teams/Design/app-mockups/-/tree/master/text-editor](text editor mockups)
repository.
+File an issue at [Teams/Design/Whiteboards](https://gitlab.gnome.org/Teams/Design/whiteboards/) to start
that process.
+Out of the design process, we expect the following:
+
+ * A mockup if changing UI components.
+ * A specification of the implementation, and what should be implemented and what should not be implemented.
+ * A breakdown of what existing code will be affected.
+ * If there are any side-effects to the change that will affect other modules in the code-base.
+
## Coding Style
Text Editor follows the GTK coding style which is similar to the GNU style.
diff --git a/README.md b/README.md
index bca9f9b..2cc748f 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,11 @@ Text Editor is a simple text editor that focuses on session management.
It works hard to keep track of changes and state even if you quit the application.
You can come back to your work even if you've never saved it to a file.
+## Contributions
+
+ * __Please do not file issues for feature requests.__ Features must go through the design process first.
File an issue at [Teams/Design/Whiteboards](https://gitlab.gnome.org/Teams/Design/whiteboards/) to start that
process. In the end you should have a mockup, implementation specification, and breakdown of how that will
change the existing code-base.
+ * Please __test Nightly before filing bugs__. You can install Nightly from Flatpak using `flatpak --user
install gnome-nightly org.gnome.TextEditor.Devel`.
+
## Features
* A simple editor focused on a solid default experience
@@ -17,7 +22,7 @@ You can come back to your work even if you've never saved it to a file.
## Dependencies
- * GTK 4.4 or newer
+ * GTK 4.6 or newer
* GtkSourceView 5.4 or newer
* Libadwaita
* libpcre (for .editorconfig support)
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]