Skip to content
Permalink
master
Go to file
 
 
Cannot retrieve contributors at this time
31 lines (16 sloc) 1.75 KB

Contributing

Bug Reports/Feature Requests

Please check the roadmap.md before adding any bugs/feature requests to Issues.

Code

Please use the develop branch as the base for any pull requests

Anyone is welcome to contribute to the project. Check out roadmap.md for bugs and planned features if you're not sure where to start.

If you're planning on doing a big chunk of work it's probably best to contact me first to make sure someone isn't already working on it.

You'll probably want to get up to scratch with Brick before working on any of the UI code.

Style

This was my first Haskell project, so the style has changed (improved?) as I've gone along.

I'm now trying to use pure instead of return, *> instead of >>, and <> instead of ++.

Git

Please use the git-flow branching model. You should only commit to feature/* branches: do not commit to develop or master directly. This will keep commit history simpler and make handling pull requests easier.

Please also use the --rebase and --ff-only options when running git pull - although if you're on your own feature/* branch this shouldn't make any difference.

Testing

I'm trying to add more unit tests to the codebase, although coverage is still pretty poor. At a minimum any pull requests should make sure all tests pass (use stack test before you commit anything). If you're adding/changing a significant amount of code then adding appropriate unit tests would be much appreciated.

You can’t perform that action at this time.