Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduce github templates with contribution guidelines (both PRs and issues) #61

Closed
kozross opened this issue Dec 4, 2018 · 1 comment
Assignees

Comments

@kozross
Copy link

kozross commented Dec 4, 2018

I'd like to contribute to massiv, specifically regarding #60, #56, #48 and some other things which I've found useful. Are there any requirements for code submitted as a PR here? For example:

  • HLint
  • Specific versions of GHC we should be compatible with
  • Code formatting requirements, such as use of a formatter

I'd rather not create extra work for you if I can avoid it.

@lehins
Copy link
Owner

lehins commented Dec 5, 2018

Really glad to hear that you are willing to contribute to massiv.
The question you bring up is a totally legit one, and I will construct some github templates in near future. I'll change the title of the ticket and make it a task for myself so I don't forget to do that.

Here is short rundown if suggestions/requirement from the top of my head:

  • hlint is an amazing tool and I'd certainly recommend running it, but it is not a requirement by any means.
  • Specific versions of ghc that must be supported can be deduced from the .travis.yaml file. As of today these are 7.10 - 8.6. This reminds me that I need to add 8.6 to the build matrix. Yay, for longer CI builds.
  • Code formatting is the simple one. Almost everywhere I use hindent for functions formatting and stylish-haskell for organizing the imports. Default setting for the above tools should be just fine.
  • The important parts are the:
    • Clear documentation, preferably with examples
    • As many unit tests and quickcheck properties in the test suite as possible. Cause those not only can be used to deduce the desired behavior of new functionality, but also validate that it conforms to it.

Thank you in advance for your contributions.

@lehins lehins self-assigned this Dec 5, 2018
@lehins lehins changed the title Contribution guidelines? Introduce github templates with contribution guidelines (both PRs and issues) Dec 5, 2018
@lehins lehins closed this as completed in 7188470 Dec 5, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants