Expectations
Elm does not follow the standard "open source" culture in certain ways.
This repo tries to document practices that people new to Elm sometimes find surprising. What are they? Why do we do them?
Work Style
-
Work is Batched - Instead of trying to respond to everything as it comes in, we try to batch the work. We find this approach produces more coherent designs, but it can be a big surprise to people coming from other projects.
-
We Like Duplicates - Just report the problem you are running into. Do not worry if something similar is open. More examples is better!
Participation Guidelines
What is good etiquete when replying to issues or pull requests?
Issues and pull requests are treated more like a work queue than a discussion platform. It is usually better to talk through stuff in a community forum and summarize it down into a clear idea before it becomes an issue.
Here are some rough guidelines to help keep things organized:
| If | Then |
|---|---|
| You have a similar SSCCE. | Open a separate issue describing your case. If it is the same, the issues will be aggregated or we will just keep the best issue. If it is different, it will not get lost! |
| Your comment will broaden the scope of the issue. | Talk through your idea in a community forum first. Probably open a separate issue. |
| You have a question. | Ask about it in a community forum. |
| Your comment is long. | Is it possible to make it shorter? |
| An issue has 10+ comments. | It is probably time to close it and create a new issue that summarizes everything. |