Development Notes

This library is intended to be minimal, providing a few functions that work reliably among many different kind of projects. If you want to contribute, Pull Request are very welcome! Please try to follow these simple rules:

  • Please create a topic branch for every separate change you make, bonus points

    if you create an issue with an acceptance criteria.

  • Update the README.md file if necessary.

  • Please do not change the version number on your Pull Request.

  • Have at least another reviewer give the thumbs up to your pull request before

    merging

  • Please make sure new changes make sense and also how they would affect future

    development before merging

Dependencies

You'll need to install Stack, once installed, you can execute the make command and learn tasks supported in the project.

You'll need to make sure you invoke make format and make lint when pushing changes, otherwise the Pull Request builder will fail.

Open Commit Policy

This library has an open commit bit policy: Anyone with an accepted pull request gets added as a repository collaborator.

Please create a feature branch and open a pull-request early for any new features or documentation improvements.

Last updated