Skip to content

Python tool for aircraft Doppler audio geolocation using historical ADS-B flight data (Source-available)

docs: add community standards and contribution templates

Cinna Davisd6c402b38db2
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 0000000..d3f97d5
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,24 @@
+---
+name: Bug report
+about: Report incorrect behavior or a failure
+labels: bug
+---
+
+## What happened?
+
+## What did you expect?
+
+## Steps to reproduce
+
+Include the command or workflow and a minimal example. Do not post private
+recordings, precise locations, credentials, or other sensitive information.
+
+## Environment and evidence
+
+- DOPPLERGEIST version or commit:
+- OS, Python and FFmpeg versions:
+- Relevant logs or error messages (remove sensitive information):
+- Data sources and limitations, if relevant:
+
+For a security vulnerability, use [private reporting](https://github.com/1337isnot1337/DOPPLERGEIST/security/advisories/new)
+instead of opening an issue.
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 0000000..a785f55
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,8 @@
+blank_issues_enabled: true
+contact_links:
+ - name: Questions and discussion
+ url: https://github.com/1337isnot1337/DOPPLERGEIST/discussions
+ about: Ask questions or discuss ideas with the community.
+ - name: Report a security vulnerability privately
+ url: https://github.com/1337isnot1337/DOPPLERGEIST/security/advisories/new
+ about: Please do not disclose vulnerabilities in public issues.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 0000000..e0f1c20
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,12 @@
+---
+name: Feature request
+about: Propose an improvement
+---
+
+## Problem or use case
+
+## Proposed change
+
+## Alternatives and additional context
+
+Please avoid posting sensitive recordings, locations, or credentials.
diff --git a/.github/ISSUE_TEMPLATE/research_evaluation.md b/.github/ISSUE_TEMPLATE/research_evaluation.md
new file mode 100644
index 0000000..7270c81
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/research_evaluation.md
@@ -0,0 +1,22 @@
+---
+name: Real-world evaluation or research
+about: Propose or report a real-recording investigation
+---
+
+## Question and intended outcome
+
+## Recording and observation sources
+
+Describe availability, permission to use the data, and any constraints on sharing.
+Do not publish private audio, precise locations, or other sensitive information.
+
+## Method and evidence
+
+Describe the recording clock, independent location reference and their uncertainty,
+inputs, search scope, settings, and how outcomes will be evaluated. If reporting
+results, include failures and inconclusive cases as well as successes; distinguish
+regional or assisted work from independent end-to-end validation.
+
+## Reproduction and limitations
+
+Include the relevant version, commands or links, and unresolved limitations.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000..1b2923b
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,15 @@
+## What does this change?
+
+## Related issue
+
+## How was it verified?
+
+List the relevant checks or real-world experiments and their outcomes. Note any
+checks not run and any remaining limitations.
+
+## Data, interfaces, and privacy
+
+Describe any changes to interfaces, dependencies, or data. For empirical results,
+identify sources, clock and location uncertainty, search scope, and unsuccessful
+or inconclusive outcomes. Do not include private recordings, precise locations,
+credentials, or other sensitive information without permission.
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
new file mode 100644
index 0000000..8a8a642
--- /dev/null
+++ b/CODE_OF_CONDUCT.md
@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+ and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+ overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+ advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+ address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..70a30c5
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,55 @@
+# Contributing to DOPPLERGEIST
+
+Thank you for helping improve DOPPLERGEIST. Contributions to code, documentation,
+real-recording evaluation, and reproducibility are welcome. Please follow the
+[Code of Conduct](CODE_OF_CONDUCT.md).
+
+## Before starting
+
+- Search the [issues](https://github.com/1337isnot1337/DOPPLERGEIST/issues) and
+ [discussions](https://github.com/1337isnot1337/DOPPLERGEIST/discussions) for
+ related work. Open an issue to discuss substantial changes or a new approach.
+- Read the [README](README.md) for current capabilities and limitations. For
+ data and research changes, see [data sources](docs/DATA_SOURCES.md),
+ [data and search](docs/DATA_AND_SCALE.md), and the relevant documentation.
+- Project agents should also follow [AGENTS.md](AGENTS.md), including its
+ coordination and real-world-data rules.
+
+## Development
+
+DOPPLERGEIST requires Python 3.11 or newer and FFmpeg. From a checkout:
+
+```bash
+python -m venv .venv
+.venv/bin/python -m pip install -e '.[test]'
+.venv/bin/dopplergeist --help
+```
+
+Make a focused change and run checks relevant to it. The standard CI workflow
+checks installation, compilation, CLI help, packaged assets and selected
+real-input behavior; see [.github/workflows/tests.yml](.github/workflows/tests.yml).
+Do not run the entire pytest suite indiscriminately: it includes synthetic-data
+tests. The project currently requires real recordings and real-world observations
+for empirical evaluation and prohibits new synthetic-data suites or generated
+benchmark inputs. Existing unit tests are software checks, not evidence of
+real-world localization accuracy.
+
+For empirical work, identify the recording and observation sources, permissions,
+clock and location evidence, settings, results, and relevant uncertainty. Report
+all outcomes, including failures and inconclusive results. Distinguish regional,
+selected, or assisted experiments from independent end-to-end validation; do not
+use evaluation truth as an input to an automatic search. Do not publish recordings,
+coordinates, credentials, or other sensitive material without permission. Follow
+[artifact guidance](docs/ARTIFACTS.md) and source-specific terms.
+
+## Pull requests
+
+Open a pull request describing the problem, the change, and the checks performed;
+link the relevant issue when there is one. Explain limitations and any changes to
+interfaces, data, or dependencies. Keep unrelated work separate and respond to
+review feedback. Contributions are subject to the repository's
+[license](LICENSE); the [legacy notice](licenses/MIT-legacy.txt) preserves
+previously granted MIT rights, and third-party materials may have separate terms.
+
+For vulnerabilities, use the private process in [SECURITY.md](SECURITY.md), not
+a public issue. General questions can go in discussions.
diff --git a/SECURITY.md b/SECURITY.md
new file mode 100644
index 0000000..2339e82
--- /dev/null
+++ b/SECURITY.md
@@ -0,0 +1,19 @@
+# Security policy
+
+## Supported versions
+
+DOPPLERGEIST is experimental software. Security fixes are considered for the
+current default branch; older revisions and releases may not receive fixes.
+
+## Reporting a vulnerability
+
+Please report suspected vulnerabilities privately using GitHub's
+[Report a vulnerability](https://github.com/1337isnot1337/DOPPLERGEIST/security/advisories/new)
+form. Do not open a public issue or discussion with vulnerability details.
+Include the affected revision or version, impact, a minimal reproduction, and
+any relevant environment details. Do not include secrets or private recordings;
+describe sensitive evidence and coordinate safe sharing with the maintainer.
+
+Maintainers will review reports and coordinate investigation, fixes, and
+appropriate disclosure through the private advisory. Response and fix times
+are not guaranteed. For ordinary bugs, use the public issue tracker.