Skip to content

Latest commit

 

History

History
26 lines (21 loc) · 1.18 KB

CONTRIBUTING.md

File metadata and controls

26 lines (21 loc) · 1.18 KB

Contributing Guidelines

Thanks for taking the time to contribute!

This document summarizes the deployment principles which govern our project.

Building "in the Open"

  • Our users appreciate the transparency of our project; in this context, building "in the open" means that anyone can:
    • see the individual pull requests this solution is comprised of;
    • understand particular changes by going back and forth between pull requests;
    • submit pull requests with their own changes.
  • In addition, we use open-source software (OSS) tools rather than proprietrary technology to build the solution.

Fully Maintained

  • Rather than providing a loose collection of scripts that are never updated, we fully maintain our project.
  • We strive to provide a high-quality solution by:
    • continuously deploying it using an internal runner to ensure performance and stability;
    • detecting regressions introduced by code changes before merging them.

Execution-focused

  • We don't just work on some grand plan that may or never be completely executed;
    • instead, we start building out the solution and iterate towards a grand plan.