From 42882923650f5fb4629334a9a0b2499b4343e4d9 Mon Sep 17 00:00:00 2001
From: stuart nelson <stuartnelson3@gmail.com>
Date: Fri, 31 Mar 2017 17:49:50 +0200
Subject: [PATCH] Add CONTRIBUTING.md for front-end code

---
 README.md              |  4 +++
 ui/app/CONTRIBUTING.md | 62 ++++++++++++++++++++++++++++++++++++++++++
 ui/app/README.md       |  7 -----
 3 files changed, 66 insertions(+), 7 deletions(-)
 create mode 100644 ui/app/CONTRIBUTING.md

diff --git a/README.md b/README.md
index ff1058d6..11ddd1e8 100644
--- a/README.md
+++ b/README.md
@@ -201,6 +201,10 @@ Start your prometheus like this, for example:
 
 > Note: make sure to have a valid `prometheus.yml` in your current directory
 
+## Contributing to the Front-End
+
+Refer to [ui/app/CONTRIBUTING.md](https://github.com/prometheus/alertmanager/blob/master/ui/app/CONTRIBUTING.md).
+
 ## Architecture
 
 ![](https://raw.githubusercontent.com/prometheus/alertmanager/4e6695682acd2580773a904e4aa2e3b927ee27b7/doc/arch.jpg)
diff --git a/ui/app/CONTRIBUTING.md b/ui/app/CONTRIBUTING.md
new file mode 100644
index 00000000..a198d36c
--- /dev/null
+++ b/ui/app/CONTRIBUTING.md
@@ -0,0 +1,62 @@
+# Contributing
+
+This document describes how to:
+
+- Set up your dev environment
+- Become familiar with [Elm](http://elm-lang.org/)
+- Develop against AlertManager
+
+## Dev Environment Setup
+
+- Go installed (https://golang.org/dl/)
+- This repo is cloned into your `$GOPATH`
+- Elm is [installed](https://guide.elm-lang.org/install.html#install)
+- Your editor is [configured](https://guide.elm-lang.org/install.html#configure-your-editor)
+- [elm-format](https://github.com/avh4/elm-format) is installed
+
+**All submitted elm code must be formatted with `elm-format`**. Install and
+execute it however works best for you. We recommend having formatting the file
+on save, similar to how many developers use `gofmt`.
+
+If you prefer, there's a make target available to format all elm source files:
+
+```
+# make format
+```
+
+Once you've installed Elm, install the dependencies listed in
+`elm-package.json`:
+
+```
+# elm package install -y
+```
+
+## Elm Resources
+
+- The [Official Elm Guide](https://guide.elm-lang.org/) is a great place to
+  start. Going through the entire guide takes about an hour, and is a good
+  primer to get involved in our codebase. Once you've worked through it, you
+  should be able to start writing your feature with the help of the compiler.
+- Check the [syntax reference](http://elm-lang.org/docs/syntax) when you need a
+  reminder of how the language works.
+- Read up on [how to write elm code](http://elm-lang.org/docs/style-guide).
+- Watch videos from the latest [elm-conf](https://www.youtube.com/channel/UCOpGiN9AkczVjlpGDaBwQrQ)
+- Learn how to use the debugger! Elm comes packaged with an excellent
+  [debugger](http://elm-lang.org/blog/the-perfect-bug-report). We've found this
+  tool to be invaluable in understanding how the app is working as we're
+  debugging behavior.
+
+## Local development workflow
+
+TODO: Add instructions for running against local AlertManager.
+
+For now, the easiest way to get started is to point your front-end to a running
+version of AlertManager. Update `baseUrl` in  `src/Utils/Api.elm` with the
+correct address. Don't commit this and send it in as part of a pull request!
+
+```
+# cd ui/app
+# go run main.go --port 5000 --debug
+```
+
+Your app should be available at `http://localhost:5000`, and automatically recompiled on file change.
diff --git a/ui/app/README.md b/ui/app/README.md
index cbc64728..a25ce023 100644
--- a/ui/app/README.md
+++ b/ui/app/README.md
@@ -57,10 +57,3 @@ Operators include:
 - `!~`
 
 See the official documentation for additional information: https://prometheus.io/docs/querying/basics/#instant-vector-selectors
-
-
-## Requirements
-
-- Go installed (https://golang.org/dl/)
-- This repo is cloned into your `$GOPATH`
-- Elm is installed (https://guide.elm-lang.org/get_started.html)