Skip to content

Latest commit

 

History

History
21 lines (12 loc) · 1023 Bytes

CONTRIBUTING.md

File metadata and controls

21 lines (12 loc) · 1023 Bytes
Raw

Contributing to rx_shared_preferences

Create a new issue

The easiest way to get involved is to create a new issue when you spot a bug, if the documentation is incomplete or out of date, or if you identify an implementation problem.

General coding guidlines

If you'd like to add a feature or fix a bug, we're more than happy to accept pull requests! We only ask a few things:

  • Ensure your code contains no analyzer errors, e.g.

    • Code is strong-mode compliant
    • Code is free of lint errors

  • Format your code with dartfmt

  • Write tests for all new code paths, consider using the Stream Matchers available from the test package.

  • Write helpful documentation

  • If you would like to make a bigger / fundamental change to the codebase, please file a lightweight example PR / issue, or contact me via my email [email protected] so we can discuss the issue.