├── curators.md ├── answers └── package-search-naming.md ├── README.md ├── LICENSE └── ISSUE_TEMPLATE.md /curators.md: -------------------------------------------------------------------------------- 1 | # Curators 2 | 3 | Who's curating which categories of issues? 4 | These are probably the best people to ask if opening an issue is appropriate. 5 | 6 | Again, if in doubt, ask in #elm-community or #elm-dev on [Slack](http://elmlang.herokuapp.com/). 7 | 8 | | Category | Curator Name | 9 | |----------|--------------| 10 | | Everything | eeue56 | 11 | -------------------------------------------------------------------------------- /answers/package-search-naming.md: -------------------------------------------------------------------------------- 1 | # Problem 2 | ## Context (What I'm Trying To Accomplish) 3 | 4 | I want my package, elm-random-generator, to show up when someone searches for JSON. It is a package which generates all kinds of random data, including JSON. 5 | 6 | ## Specifics (Where I'm Stuck) 7 | 8 | If I type json into package.elm-lang.org, only packages with json in the name come up. Should I name my package elm-random-json-generator? 9 | 10 | 11 | # Solution 12 | 13 | The contents of both the `summary` and the `name` of your package are searchable. You can include the term you want people to find in either of those fields. 14 | 15 | ## Naming guidelines 16 | 17 | When naming a package, go through the following list: 18 | 19 | - Is the name descriptive? 20 | - Prefer "elm-test" to "octestpus" 21 | - Is there already a package with the same name? 22 | - If so, can my changes be merged with that package instead? 23 | - If not, can I think of a better name? 24 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Code Confusion Catalog 2 | 3 | This repo catalogs painful and confusing interactions with [Elm](http://elm-lang.org/). 4 | We do this to distill a whole lot of confusion down to a handful of solutions. 5 | 6 | If that sounds weird to you, watch [*Code is the Easy Part* by Evan Czaplicki](https://www.youtube.com/watch?v=DSjbTC-hvqQ&list=PLglJM3BYAMPH2zuz1nbKHQyeawE4SN0Cd&index=1) for more context. 7 | 8 | ## Should I Open an Issue? 9 | 10 | If you're looking for help, you're probably better off asking on [Reddit](https://www.reddit.com/r/elm/), or in the #beginners or #general channel on [the Elm Slack](http://elmlang.herokuapp.com/). 11 | When you do that, your problem will probably be addressed and solved. 12 | 13 | If your issue is a good example a confusion we're collecting, someone will direct you back here. 14 | Super! 15 | Go ahead and [open a new issue](https://github.com/elm-community/code-confusion-catalog/issues/new) and fill out the template there. 16 | 17 | ## When should I Send Someone Here? 18 | 19 | Generally, when someone has encountered a difficult pattern that works but could be better. The rules are still loose at the moment - but may be more exact soon. 20 | If in doubt, ask in #elm-community or #elm-dev on [Slack](http://elmlang.herokuapp.com/). 21 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | BSD 3-Clause License 2 | 3 | Copyright (c) 2017, The Elm Community 4 | All rights reserved. 5 | 6 | Redistribution and use in source and binary forms, with or without 7 | modification, are permitted provided that the following conditions are met: 8 | 9 | * Redistributions of source code must retain the above copyright notice, this 10 | list of conditions and the following disclaimer. 11 | 12 | * Redistributions in binary form must reproduce the above copyright notice, 13 | this list of conditions and the following disclaimer in the documentation 14 | and/or other materials provided with the distribution. 15 | 16 | * Neither the name of the copyright holder nor the names of its 17 | contributors may be used to endorse or promote products derived from 18 | this software without specific prior written permission. 19 | 20 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 21 | AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 23 | DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 24 | FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25 | DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 26 | SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 27 | CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 28 | OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 29 | OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 30 | -------------------------------------------------------------------------------- /ISSUE_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | 14 | 15 | ## Context (What I'm Trying To Accomplish) 16 | 17 | 20 | 21 | ## Specifics (Where I'm Stuck) 22 | 23 | 26 | 27 | ## SSCCE 28 | 29 | 32 | --------------------------------------------------------------------------------