elm-community / list-extra

Convenience functions for working with List.
http://package.elm-lang.org/packages/elm-community/list-extra/latest
MIT License
135 stars 59 forks source link

Contributing section in the readme #63

Closed Chadtech closed 7 years ago

Chadtech commented 7 years ago

I am noticing a pretty typical pattern of requirements to pull requests, and issues. To speed up discussion, and make everything clearer, we can state these things out right in the readme. I have added the following to the readme..

## Contributing

Pull requests are welcome. You can expect some kind of response within 5 days.

If you are adding a new function please..
0 Include [documentation](http://package.elm-lang.org/help/documentation-format) and make sure it has a code snippet demonstrating what the function does.
1 Give a detailed use case where your function would come in handy in the PR.
2 Add tests to `Tests/Tests.elm`

If you are improving existing functions please demonstrate the performance gains in something like [Ellie](https://ellie-app.com/) and by using a benchmark library like [this one](http://package.elm-lang.org/packages/BrianHicks/elm-benchmark/latest).

What do you think? Does that sound agreeable? Is my language good?