Merge pull request #1 from boydm/master

Update to latest master from boyd

Author: grahamhay

.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[Makefile]
+indent_style = tab

.formatter.exs

@@ -1,4 +1,3 @@
-# Used by "mix format"
 [
   inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"]
 ]

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,40 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of the level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct. By adopting this Code of Conduct, project
+maintainers commit themselves to fairly and consistently applying these
+principles to every aspect of managing this project. Project maintainers who do
+not follow or enforce the Code of Conduct may be permanently removed from the
+project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing or otherwise unacceptable behavior may be
+reported by opening an issue or contacting one or more of the project
+maintainers.
+
+This Code of Conduct is adapted from the [Contributor
+Covenant](http://contributor-covenant.org), version 1.2.0, available at
+[http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/)

CONTRIBUTING.md renamed to .github/CONTRIBUTING.md

@@ -1,33 +1,39 @@
 # Contributing to Scenic
 
 Please take a moment to review this document in order to make the contribution
-process easy and effective for everyone involved!
-Also make sure you read our [Code of Conduct](CODE_OF_CONDUCT.md) that outlines our commitment towards an open and welcoming environment.
+process easy and effective for everyone involved! Also, make sure you read our
+[Code of Conduct](CODE_OF_CONDUCT.md) that outlines our commitment towards an
+open and welcoming environment.
 
 ## Components
 
-There are many components that could be written and shared with the community. Only a few really core ones should be in the Scenic package itself. If you have ideas for components, I would love the see the community supply optional packages of them for developers to use.
+There are many components that could be written and shared with the community.
+Only a few really core ones should be in the Scenic package itself. If you have
+ideas for components, I would love the see the community supply optional
+packages of them for developers to use.
 
-Each component package should have the component modles themselves, and a "Components" module that contains helper functions to make adding the new components very simple.
-
-See the code for Scenic.Components for example helper functions.
+Each component package should have the component models themselves, and a
+"Components" module that contains helper functions to make adding the new
+components very simple.
 
+See the code for `Scenic.Components` for example helper functions.
 
 ## Using the issue tracker
 
 Use the issues tracker for:
 
-* [bug reports](#bug-reports)
-* [submitting pull requests](#pull-requests)
-
-Please **do not** use the issue tracker for personal support requests nor feature requests. Support requests should be sent to:
+* [Bug Reports](#bug-reports)
+* [Submitting Pull Requests](#pull-requests)
 
+Please **do not** use the issue tracker for personal support requests nor
+feature requests. Support requests should be sent to:
 
 Still working on this bit...
 
-For now, please play around with it. I would gladly accept help documenting it. 
+For now, please play around with it. I would gladly accept help documenting it.
 
-Over the coming weeks, I'll set up discussion mailing lists and whatever. Simply haven't gotten there yet.
+Over the coming weeks, I'll set up discussion mailing lists and whatever. Simply
+haven't gotten there yet.
 
 
 We do our best to keep the issue tracker tidy and organized, making it useful
@@ -36,9 +42,9 @@ making it easier for developers to [contribute to Scenic](#pull-requests).
 
 ## Bug reports
 
-A bug is either a _demonstrable problem_ that is caused by the code in the repository,
-or indicate missing, unclear, or misleading documentation. Good bug reports are extremely 
-helpful - thank you!
+A bug is either a _demonstrable problem_ that is caused by the code in the
+repository or indicate missing, unclear, or misleading documentation. Good bug
+reports are extremely helpful - thank you!
 
 Guidelines for bug reports:
 
@@ -48,45 +54,50 @@ Guidelines for bug reports:
 2. **Check if the issue has been fixed** — try to reproduce it using the
    `master` branch in the repository.
 
-3. **Isolate and report the problem** — ideally create a reduced test
+3. **Isolate and report the problem** — ideally, create a reduced test
    case.
 
-Please try to be as detailed as possible in your report. Include information about
-your Operating System, as well as your Erlang, Elixir and Scenic versions. Please provide steps to
-reproduce the issue as well as the outcome you were expecting! All these details
-will help developers to fix any potential bugs.
+Please try to be as detailed as possible in your report. Include information
+about your Operating System, as well as your Erlang, Elixir and Scenic versions.
+Please provide steps to reproduce the issue as well as the outcome you were
+expecting! All these details will help developers to fix any potential bugs.
 
 Example:
 
-> Short and descriptive example bug report title
->
-> A summary of the issue and the environment in which it occurs. If suitable,
-> include the steps required to reproduce the bug.
->
-> 1. This is the first step
-> 2. This is the second step
-> 3. Further steps, etc.
->
-> `<url>` - a link to the reduced test case (e.g. a GitHub Gist)
->
-> Any other information you want to share that is relevant to the issue being
-> reported. This might include the lines of code that you have identified as
-> causing the bug, and potential solutions (and your opinions on their
-> merits).
+```md
+Short and descriptive example bug report title
+
+A summary of the issue and the environment in which it occurs. If suitable,
+include the steps required to reproduce the bug.
+
+1. This is the first step
+2. This is the second step
+3. Further steps, etc.
+
+`<url>` - a link to the reduced test case (e.g. a GitHub Gist)
+
+Any other information you want to share that is relevant to the issue being
+reported. This might include the lines of code that you have identified as
+causing the bug, and potential solutions (and your opinions on their merits).
+```
 
 ## Feature requests
 
-Feature requests are welcome and should be discussed on [the phoenix-core mailing list](http://groups.google.com/group/phoenix-core). But take a moment to find
-out whether your idea fits with the scope and aims of the project. It's up to *you*
-to make a strong case to convince the community of the merits of this feature.
-Please provide as much detail and context as possible.
+
+Feature requests are welcome and should be currently be discussed as an issue
+in github. This will change to either a topic in Elixir forum or a mail-list soon.
+
+Before you make a request however, pleaes take a moment to
+find out whether your idea fits with the scope and aims of the project. It's up
+to *you* to make a strong case to convince the community of the merits of this
+feature. Please provide as much detail and context as possible.
 
 ## Contributing Documentation
 
 Code documentation (`@doc`, `@moduledoc`, `@typedoc`) has a special convention:
 the first paragraph is considered to be a short summary.
 
-For functions, macros and callbacks say what it will do. For example write
+For functions, macros and callbacks say what it will do. For example write,
 something like:
 
 ```elixir
@@ -96,19 +107,19 @@ Marks the given value as HTML safe.
 def safe({:safe, value}), do: {:safe, value}
 ```
 
-For modules, protocols and types say what it is. For example write
-something like:
+For modules, protocols and types say what it is. For example, write something
+like:
 
 ```elixir
-defmodule Phoenix.HTML do
+defmodule MyModule.HTML do
   @moduledoc """
   Conveniences for working HTML strings and templates.
   ...
   """
 ```
 
 Keep in mind that the first paragraph might show up in a summary somewhere, long
-texts in the first paragraph create very ugly summaries. As a rule of thumb
+texts in the first paragraph create very ugly summaries. As a rule of thumb,
 anything longer than 80 characters is too long.
 
 Try to keep unnecessary details out of the first paragraph, it's only there to
@@ -122,36 +133,36 @@ are often a great help in explaining what a function does.
 
 ## Pull requests
 
-Good pull requests - patches, improvements, new features - are a fantastic
-help. They should remain focused in scope and avoid containing unrelated
-commits.
+Good pull requests - patches, improvements, new features - are a fantastic help.
+They should remain focused in scope and avoid containing unrelated commits.
 
-**IMPORTANT**: By submitting a patch, you agree that your work will be
-licensed under the license used by the project.
+> **IMPORTANT**: By submitting a patch, you agree that your work will be licensed
+under the license used by the project.
 
 If you have any large pull request in mind (e.g. implementing features,
-refactoring code, etc), **please ask first** otherwise you risk spending
-a lot of time working on something that the project's developers might
-not want to merge into the project.
+refactoring code, etc), **please ask first** otherwise you risk spending a lot
+of time working on something that the project's developers might not want to
+merge into the project.
 
-Please adhere to the coding conventions in the project (indentation,
-accurate comments, etc.) and don't forget to add your own tests and
-documentation. When working with git, we recommend the following process
-in order to craft an excellent pull request:
+Please adhere to the coding conventions in the project (indentation, accurate
+comments, etc.) and don't forget to add your own tests and documentation. When
+working with git, we recommend the following process in order to craft an
+excellent pull request:
 
-1. [Fork](https://help.github.com/articles/fork-a-repo/) the project, clone your fork,
-   and configure the remotes:
+1. [Fork](https://help.github.com/articles/fork-a-repo/) the project, clone your
+   fork, and configure the remotes:
 
    ```bash
    # Clone your fork of the repo into the current directory
-   git clone https://github.com/<your-username>/phoenix
+   git clone https://github.com/<your-username>/scenic
    # Navigate to the newly cloned directory
-   cd phoenix
+   cd scenic
    # Assign the original repo to a remote called "upstream"
-   git remote add upstream https://github.com/phoenixframework/phoenix
+   git remote add upstream https://github.com/boydm/scenic
    ```
 
-2. If you cloned a while ago, get the latest changes from upstream, and update your fork:
+2. If you cloned a while ago, get the latest changes from upstream, and update
+   your fork:
 
    ```bash
    git checkout master
@@ -172,9 +183,9 @@ in order to craft an excellent pull request:
 
 4. Commit your changes in logical chunks. Keep your commit messages organized,
    with a short description in the first line and more detailed information on
-   the following lines. Feel free to use Git's
-   [interactive rebase](https://help.github.com/articles/about-git-rebase/)
-   feature to tidy up your commits before making them public.
+   the following lines. Feel free to use Git's [interactive
+   rebase](https://help.github.com/articles/about-git-rebase/) feature to tidy
+   up your commits before making them public.
 
 5. Make sure all the tests are still passing.
 
@@ -212,24 +223,25 @@ Thank you for your contributions!
 These Guides aim to be inclusive. We use "we" and "our" instead of "you" and
 "your" to foster this sense of inclusion.
 
-Ideally there is something for everybody in each guide, from beginner to expert.
+Ideally, there is something for everybody in each guide, from beginner to expert.
 This is hard, maybe impossible. When we need to compromise, we do so on behalf
 of beginning users because expert users have more tools at their disposal to
 help themselves.
 
 The general pattern we use for presenting information is to first introduce a
 small, discreet topic, then write a small amount of code to demonstrate the
-concept, then verify that the code worked.
+concept, then verifies that the code worked.
 
 In this way, we build from small, easily digestible concepts into more complex
 ones. The shorter this cycle is, as long as the information is still clear and
 complete, the better.
 
 For formatting the guides:
 
-- We use the "elixir" code fence for all module code.
-- We use the "console" code fence for iex and shell commands.
-- We use backticks for filenames and directory paths.
-- We use backticks for module names, function names, and variable names.
+* We use the "elixir" code fence for all module code.
+* We use the "console" code fence for iex and shell commands.
+* We use backticks for filenames and directory paths.
+* We use backticks for module names, function names, and variable names.
 
-This contribution guide is adapted from the [Phoenix contribution guide](https://github.com/phoenixframework/phoenix/blob/master/CONTRIBUTING.md).
+This contribution guide is adapted from the [Phoenix contribution
+guide](https://github.com/phoenixframework/phoenix/blob/master/CONTRIBUTING.md).