Skip to content
This repository has been archived by the owner on Oct 1, 2019. It is now read-only.

Latest commit

 

History

History
29 lines (22 loc) · 1.22 KB

CONTRIBUTING.md

File metadata and controls

29 lines (22 loc) · 1.22 KB

GUIDELINE

Contributions guideline:

  • Keep the code simple
  • Don't add extra dependency: dependencies have costs that is better to avoid.
  • compatibility: keep the code compatible with previous versions of GHC, and base.
  • Don't drop older SSL / TLS features (even if insecure) without proper discussion.
  • Limit the change of API if necessary. it's usually better to create new API than change current one.
  • Notable exception to previous rule: security fix have priority to other considerations.

MAINTAINERS

  • Don't commit code directly to master, apart from targeted fixes (e.g. documentation improvements, build scripts, etc).
  • PRs: make sure they pass compilations and runtime tests before merging
  • Let someone else merge your own PR, or give other maintainers a chance to review
  • Separate meaningful code from syntax changes
  • Prefer rebased code when merging. A clean history is a readable history.
  • Merge with a merge point to keep the action of merging visible instead of fast-forward. it allows to easily revert merge point when necessary and easier reading of histor.

SUPPORT

  • Need to support all the GHC versions listed in the .travis file.
  • Operating systems: Windows, OSX and unix (Linux, BSD)