DESIGN.md

syncpad design

Table of Contents

• syncpad design
  • Table of Contents
  • What does this package do?
  • How is it different from what I already use?
  • Why should I adopt it?
  • How do I contribute to this package?
  • How do I adopt this design in my framework, language, etc.?

What does this package do?

syncpad is designed to sync common config files between projects for multi-repo organizations.

How is it different from what I already use?

WORK IN PROGRESS: syncpad is still in the design phase.

Why should I adopt it?

WORK IN PROGRESS: syncpad is still in the design phase.

How do I contribute to this package?

syncpad is a part of the Open Source Universe. All Projects in the Open Source Universe follow the same Contribution Guidelines & Process.

We would love for you to contribute to the Open Source Universe!

Also check out the rewards offered for contributing to the Open Source Universe.

How do I adopt this design in my framework, language, etc.?

syncpad only plans to initially support Typescript & JavaScript Applications. However, we would love for the community to contribute versions for other languages (Java, Go, etc.)

When creating an implementation for another language, we encourage that the implementation follow the Open Source Universe Principles & follows the same design (this document) & specifications (unit tests) as the Typescript & JavaScript Implementation.