Skip to content

Latest commit

 

History

History
24 lines (17 loc) · 958 Bytes

CONTRIBUTING.md

File metadata and controls

24 lines (17 loc) · 958 Bytes

Contributing

Contributions a very welcome!

  • Be patient. This is a voluntary effort and things may take time.

Issues

Issues are welcome however we don't have a lot of resources so:

  • Don't look for fixes on prior versions. Even if upgrading is painful please try the latest version of the package and Go before raising an issue.

Code

  • Please contribute code via a pull request
  • Use the latest versions of this package and Go
    • Do not try and backport features or Go compatibility
  • Code should be idiomatic to the package
    • This package is careful about naming and package layout to emphasize polymorphism.
  • Code should be DRY
    • No syntactic sugar - i.e. no I wrote language/package X style signatures to existing functions.
  • Balance efficiency with cleanliness
    • Don't write WET code unless it is a significant efficiency/feature gain.
    • Don't write container specific functions where it could be cleanly added to sequence.