Skip to content

Latest commit

 

History

History
20 lines (13 loc) · 1.58 KB

CONTRIBUTING.md

File metadata and controls

20 lines (13 loc) · 1.58 KB

How to contribute to Pinelab's projects?

Contribution's are always welcome! Just:

Coding guidelines

To keep code quality high and maintainable, we've set up a few guidelines to help you ✨

  • Automated tools - We rely heavily on automated tools to keep our projects maintainable, so please make sure you've added test cases if necessary and linted your code.

  • Logging - Only log errors if it's actually an error: An errors is something needs to be fixed by a developer.

    • These should be warnings, not errors: Bad user input. Bad config that can be solved by changing settings via a UI.
    • These are actual errors: A request failed. An async job failed after it's max retries.

(This document is still a work in progress...)