Skip to content

Latest commit

 

History

History
43 lines (29 loc) · 1.88 KB

CONTRIBUTING.md

File metadata and controls

43 lines (29 loc) · 1.88 KB

Contributing

Project Scope

This plugin originates from an internal need at XOi Technologies to keep log groups when doing Cloudformation operations.

Feature Requests

As this project is worked on during company time, feature requests that do not add direct value to our operations needs may receive a low internal priority and be deferred to the open source community for implementation. With that being said, we still highly encourage you to use the issues section as a conversation portal!

Feedback and comments

Feel free to use the issues section as a forum for civilized discussion!

Issues

Please report bugs using GitHub Issues. If possible, providing a mocha style unit test is also greatly appreciated and might even speed up our response time.

Pull Requests

Code style

  • We use Prettier (and eslint-prettier) for code formatting

  • We use ESLint for code linting

  • We use mocha for running tests, sinon for mocks and spies, and Node's builtin assert module for assertion.

  • We use Husky to manage a Git pre-commit hook that automatically runs npm run lint-staged to enforce all the above. Please run yarn prepare or npm run prepare or yarn prepare in order to install these hooks within this repository and minimize CI surprises.

  • We try to aim for 100% coverage but don't like to play a numbers game.

    • Writing unit tests that increase code coverage but does not perform logical assertions is actually detrimental and gives us a falsified overview of our perceived test coverage.
    • Our current assertions are probably not perfect either! Don't hesitate to improve them.

Runtime targets

We aim to provide excellent support for LTS releases of Node.js. "Prehistoric" versions (Node 8, 10) as well as bleeding-edge releases may be too much work to support, but you are free to fork and open a PR if you need support for something in particular,