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

Latest commit

 

History

History
44 lines (32 loc) · 1.47 KB

CONTRIBUTING.md

File metadata and controls

44 lines (32 loc) · 1.47 KB
Raw

Contributing to nfscan

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to nfscan and its packages, which are hosted in the nfscan Organization on GitHub. These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.

Contributing Code

  • A good patch:

    • is clear.
    • works across all supported versions of Python (2.7.x >).
    • has comments included as needed.

  • A test case that demonstrates the previous flaw that now passes with the included patch.

  • Must be appropriately licensed (MIT).

Reporting An Issue/Feature

  • Check to see if there's an existing issue/pull request for the bug/feature. All issues are at https://github.com/nfscan/ocr-process-service/issues and pull reqs are at https://github.com/nfscan/ocr-process-service/pulls.

  • If there isn't an existing issue there, please file an issue. The ideal report includes:

    • A description of the problem/suggestion.

    • How to recreate the bug.

    • If relevant, including the versions of your:

      • Python interpreter
      • Operational System
      • AWS region
      • Optionally of the other dependencies involved

    • If possible, create a pull request with a (failing) test case demonstrating what's wrong. This makes the process for fixing bugs quicker & gets issues resolved sooner.