agentleFS
Sign inStart free
apacheapache/iotdb/distribution/AGENTS.md

iotdb / distribution

AGENTS.md6.4k starsChanged 4 years agoApache-2.0View on GitHub

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…

We split this AGENTS.md into the rules it gives an agent

4 rules. About 0 are common, 1 is distinctive, and 3 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 3

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Treat pom.xml and src/assembly/ as the sources of package layout.

    line 29
  2. Very specific:

    Keep LICENSE, NOTICE, and bundled dependency licenses in the resulting archives.

    line 37
  3. Distinctive:

    Check the standalone node and integration-test assembly descriptors as well when changing shared configuration or script selection.

    line 58
  4. Very specific:

    Run the clean distribution build from the root build instructions.

    line 66

≈ “Common” is an estimate: at least 1 in 5 of the 36,368 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.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. -->

Distribution Guidelines

These instructions apply to distribution/ and supplement the repository instructions.

Assembly ownership and artifact identity

  • Treat pom.xml and src/assembly/ as the sources of package layout. Edit the original configuration or script source, not staged files or archives under target/.
  • Preserve the default all-bin, library-udf-bin, library-pipe-bin, and edge-bin assemblies. with-ainode and with-cpp add their own distributions; keep profile descriptors additive so enabling one does not replace the default descriptor list.
  • Assembly IDs determine attached artifact classifiers. Keep each ID unique, especially edge-bin, and check final archive/base-directory names and SHA-512 checksum includes when adding or renaming an artifact. Preserve existing outputs for every affected profile.
  • Keep LICENSE, NOTICE, and bundled dependency licenses in the resulting archives; reuse src/assembly/common-files.xml and the AINode-specific component where applicable.
  • Preserve executable file modes and Maven filtering for shared environment scripts, including iotdb-common.sh and windows/iotdb-common.bat. Check includes/excludes against both Unix and Windows paths. Read scripts/AGENTS.md when changing script contents or availability, and AINode instructions for AINode packaging.

Edge package boundaries

  • src/assembly/edge.xml produces apache-iotdb-<version>-edge-bin.zip for the combined ConfigNode/DataNode process.
  • Edge system defaults come from iotdb-core/node-commons/src/assembly/resources/conf/edge/; Edge logging configuration comes from distribution/src/assembly/resources/conf-edge/. Keep these separate from standard configuration. Standard node, all-in-one, and integration-test packages must not acquire Edge defaults; preserve edge/** exclusions wherever shared configuration directories are copied recursively.
  • Package the Edge start/stop pair and compatible CLI/tools. Exclude tools requiring standalone node launchers or environment files, including standalone daemon, destroy, and health-check scripts. The explicit Edge daemon/destroy replacements are intentional exceptions; retain their inclusion without restoring the standalone tools.
  • Check the standalone node and integration-test assembly descriptors as well when changing shared configuration or script selection; a correct Edge archive does not establish that other packages are unaffected.

Packaging verification

For changes to assembly descriptors, packaged resources, or artifact wiring:

  1. Run the clean distribution build from the root build instructions. Enable any affected optional profile as well; an old archive in target/ is not evidence of a successful new build.
  2. Inspect the produced archives and SHA-512 files under distribution/target/. Verify all expected artifacts for the active profiles, archive roots, configuration, dependency jars, licenses, Unix executable modes, and Windows entries. Confirm unwanted tools and Edge-only defaults are absent from the other packages.
  3. Inspect the Edge zip and verify startup/shutdown from a freshly extracted package using an isolated installation. For Edge package selection changes, also run the script/assembly checks described in scripts/AGENTS.md.
  4. For Edge runtime changes, follow the build and Tree/Table read-write verification in integration-test/AGENTS.md. Keep the IT commands there rather than duplicating them here.

Download now (ZIP)

Trending

More talk lately.about the whole repository

Dec 2025: 0 mentionsJan 2026: 0 mentionsFeb 2026: 1 mentionMar 2026: 1 mentionApr 2026: 2 mentionsMay 2026: 0 mentionsJun 2026: 0 mentionsJul 2026: 1 mentionAug 2026: 0 mentionsSep 2026: 1 mentionOct 2026: 1 mentionNov 2026: 0 mentions
Dec 2025Jun 2026Nov 2026
Mentions a month of the apache/iotdb repository that our weekly crawl found. There is no adoption data for this file yet.

Who's talking about apache/iotdb

The biggest 5 of 28 mentions linking to the repository that our crawl found. Each line is their own headline.

See all 28

Talked about on GitHub, Bluesky and Hacker News (28 times).

On GitHub · 23

18 more on GitHub

On Bluesky · 4

On Hacker News · 1

  • Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.

    Of the AGENTS.md files we read, the 28,693 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

  • In this repository3 other files it gives its agents.

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free