Rename README file

1 files changed, 65 insertions, 0 deletions

diff --git a/README.org b/README.org
new file mode 100644
index 0000000..0dccf52
--- /dev/null
+++ b/README.org
@@ -0,0 +1,65 @@
+-*- mode: org -*-
+
+This service is intended to assist with quality assurance within
+Guix. That is maintaining and improving the quality of many aspects of
+Guix, like packages for example.
+
+* Ideas
+** TODO General functionality
+
+*** TODO Support signing in via email
+*** TODO Expose prometheus metrics for tracking trends and app performance
+
+
+** TODO Show information about the master branch
+
+*** TODO Broken packages
+*** TODO Broken system tests
+**** TODO Submit builds for master branch system tests
+*** TODO Broken fixed output package derivations
+*** TODO Lint warnings
+
+
+** TODO Show information about non-master branches (staging, core-updates, ...)
+
+*** TODO Support configuing builds for a branch (when signed in)
+*** TODO Show comparison compared to the master branch
+**** TODO Broken packages
+**** TODO Broken system tests
+**** TODO Broken fixed output package derivations
+**** TODO New lint warnings
+
+
+** TODO Show package reproducibility statistics
+
+This will provide a better URL and faster page load times compared to
+directly going to data.guix.gnu.org or data.qa.guix.gnu.org.
+
+
+
+** TODO Show information about patches
+
+*** TODO Move functionality from Laminar jobs in to the qa-frontpage
+
+Some of this is in Guile already, but would be better if brought in to
+the qa-frontpage: https://laminar.cbaines.net/cfg/scripts/
+
+**** TODO Applying patches and creating branches
+**** TODO Deleting branches once issues have been closed
+**** TODO Support applying patches to a newer master revision (when signed in)
+
+*** TODO Provide image badges about issue status (for use on issues.guix.gnu.org)
+**** TODO Summarise the information for an issue in to a single status
+
+*** TODO Improve display of package build changes
+**** TODO More clearly list which packages have been broken or fixed
+*** TODO Improve display of lint warning changes
+**** TODO Say which package the lint warnings apply to
+
+*** TODO Show when there are comments/messages on the issue
+
+To highlight when there is discussion that might need reading before
+merging the patch.
+
+*** TODO Show changes with system tests
+**** TODO Submit builds for system tests when affected by patches