Skip to content
This repository has been archived by the owner on Apr 19, 2020. It is now read-only.

Commit

Permalink
Added guide to add loading messages.
Browse files Browse the repository at this point in the history
  • Loading branch information
ReilySiegel committed Jul 7, 2018
1 parent fc8aaf2 commit e8c132f
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 0 deletions.
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ about the problem. We also set aside issues that are [good for new
contributors](/../issues?label_name[]=good+first+issue). If you are
looking for something to contribute, check out these issues.

We also keep a list of [witty loading messages](/doc/loading.md) that make a great first contribution.

## Forking the Project

Forking a project makes a copy of the project on your own GitLab
Expand Down
26 changes: 26 additions & 0 deletions doc/loading.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Loading Messages

## Overview

Flexblock uses (arguably) witty loading messages to not only improve the user experience while waiting for the page to load, but also because adding to these messages is easy, and makes a great first contribution! The conde changes to add a new loading message are extremely simple (you just need to add your new message to a list of strings), so that you can focus on the contributing process rather than complex code. This guide will walk you through the steps of adding a new loading message. This guide assumes you have read [CONTRIBUTING.md](CONTRIBUTING.md), and have created your own fork of flexblock. This guide only covers the changes in the code.

## Adding a New Message

The loading messages are stored in the file `src/clj/flexblock/views/loading.clj`. Inside there is a var definition that looks something like this:

```clojure
(def messages
["A fun loading message!"
"Another fun loading message!"
,,,])
```

You can add your loading message by simply adding it to the list. Make sure to keep the list in alphabetical order!

```clojure
(def messages
["A fun loading message!"
"Another fun loading message!"
"My brand new super awesome loading message!"
,,,])
```

0 comments on commit e8c132f

Please sign in to comment.