docs/adding-integration.md

<!--

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

-->

# Adding an integration

Create a top-level directory named after the external system, using a concise
lowercase name. Keep code for the same integration together even when it uses
more than one programming language.

## Documentation

The module README should describe:

- What the integration does and its main use cases.
- Prerequisites, installation, and build instructions.
- A minimal usage example and links to detailed documentation.
- Supported versions and platforms, with known limitations.
- Source code and instructions for running tests.

Link to external implementations and guides where appropriate. Add the module to
both root READMEs. Write for users and contributors; keep setup history and task
progress out of project descriptions.

## Implementation

Keep source, tests, examples, and documentation within the module. Preserve a
useful upstream layout rather than imposing a common directory structure on
unrelated build systems. Add directories and build files with the content they
support.

Use the [installed TsFile SDK](dependencies.md). Document host-specific linkage
and runtime deployment requirements. General-purpose TsFile functionality belongs
in the core project.

## Source and test data

When importing code, record the original repository and commit, and preserve its
license and attribution. Include relevant tests and documentation.

Prefer small generated examples or documented fixtures. Do not commit SDK
archives, compiled extensions, private data, or large datasets. Small TsFile and
database fixtures may be tracked when needed by tests.