Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 66 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
name: Bug report
description: Something broke or behaved in a way you didn't expect
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for reporting. A rough description and the command you ran is plenty — we can dig from there.
- type: textarea
id: what-happened
attributes:
label: What happened
description: What did you expect to happen, and what happened instead?
validations:
required: true
- type: textarea
id: command
attributes:
label: Command you ran
description: The exact command(s), if there was one.
render: shell
validations:
required: false
- type: input
id: tycoon-version
attributes:
label: tycoon version
description: Output of `tycoon --version`
placeholder: "0.1.9"
validations:
required: true
- type: input
id: python-version
attributes:
label: Python version
placeholder: "3.12"
validations:
required: true
- type: dropdown
id: os
attributes:
label: Operating system
options:
- macOS
- Linux
- Windows (WSL)
- Windows (native)
- Other
validations:
required: true
- type: textarea
id: stack
attributes:
label: Stack config
description: The `stack:` block from your `tycoon.yml`, if relevant (ingestion / warehouse / bi / orchestrator).
render: yaml
validations:
required: false
- type: textarea
id: logs
attributes:
label: Logs or error output
description: Paste any error output. It will be formatted as code.
render: shell
validations:
required: false
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Questions & discussion
url: https://github.com/Database-Tycoon/tycoon-cli/discussions
about: Have a question, want setup help, or want to share what you're building? Start a discussion — we read every post.
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: Feature request
description: Suggest an idea or improvement
labels: ["enhancement"]
body:
- type: textarea
id: problem
attributes:
label: What's the problem?
description: What are you trying to do, and where does tycoon get in the way today?
validations:
required: true
- type: textarea
id: solution
attributes:
label: What would you like to see?
description: A rough idea is fine — no need for a full design.
validations:
required: true
- type: dropdown
id: area
attributes:
label: Which part of tycoon?
options:
- "tycoon init (scaffolding / stack config)"
- "data sources (ingestion / dlt)"
- "data transform (dbt)"
- "data analyze (Rill / dashboards)"
- "data history / status (observability)"
- "ask (Nao / natural language)"
- "Not sure / other"
validations:
required: false
- type: textarea
id: alternatives
attributes:
label: Anything you've tried or considered?
description: Workarounds, other tools, alternatives you weighed. Optional.
validations:
required: false
29 changes: 29 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<!-- Thanks for contributing to tycoon-cli! Keep this short — a rough description is plenty. -->

## What this does

<!-- One or two sentences. What changes, and why. -->

## Linked issue

Closes #

## Type of change

- [ ] Bug fix
- [ ] New feature
- [ ] Docs
- [ ] Refactor / internal
- [ ] Other:

## Checklist

- [ ] `pre-commit run --all-files` passes
- [ ] Tests pass locally, and the offline `csv-import` pipeline still runs end to end (this is the CI gate — if it breaks, the release is blocked)
- [ ] Added or updated tests where it made sense
- [ ] Updated `CHANGELOG.md` if this is user-facing
- [ ] Updated docs / README if behavior or commands changed

## Notes for reviewers

<!-- Anything worth calling out: tradeoffs, things you're unsure about, follow-ups. Optional. -->
78 changes: 78 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
# Code of Conduct

Database Tycoon is a small team, and this is a public project. It only works
if people feel comfortable showing up: asking a basic question, filing a rough
bug, disagreeing about a design. This document is the short version of how we
keep it that way. It applies to everyone who shows up in an issue, a pull
request, or a discussion.

## What we expect

Assume the person on the other end is smart and acting in good faith, even when
they're new, even when they're wrong. Be direct about the work without being
sharp with the person. Concretely, that means:

* Give feedback on the code, the idea, or the decision — not the human.
* Take disagreement as normal. Explain your reasoning; accept that someone
might explain theirs back.
* When you're wrong, say so and move on. Nobody here is keeping score.
* Make room for people who know less than you do. You were there once.

## What we won't accept

* Harassment of any kind, public or private.
* Sexualized language, imagery, or attention.
* Personal, political, or identity-based attacks — insults or dismissiveness
aimed at who someone is rather than what they said.
* Trolling, deliberate derailing, or sustained disruption.
* Publishing someone's private information without their explicit permission.
* Anything else that a reasonable person would read as harassment in a
professional setting.

This applies 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, caste, color, religion, or sexual orientation.

## Where this applies

Everywhere the project lives — issues, pull requests, discussions, commit
history — and anywhere someone is representing the project in public, like an
official account or an event.

## Reporting

If something crosses a line, tell us. Email info@databasetycoon.com with what
happened. You don't need to have it perfectly documented; send a rough account
and we'll take it from there.

We'll look into every report promptly and fairly, and we'll keep the reporter's
identity private. Reporting something in good faith will never count against
you, full stop.

## What happens after a report

Maintainers are responsible for enforcing this, and we'll match the response to
what actually happened:

1. **A quiet word.** For a one-off — language or behavior that was out of line
but not serious — a private note explaining what was wrong and why. Sometimes
with a request to apologize.
2. **A warning.** For a clearer violation or a repeat: a warning, plus a period
of no interaction with the people involved, across project spaces and
outside them. Ignoring that leads to a ban.
3. **A temporary ban.** For a serious violation or sustained bad behavior: time
away from all project interaction. Breaking the terms of the ban makes it
permanent.
4. **A permanent ban.** For a pattern of violations, harassment of an
individual, or hostility toward a group.

We'll explain our reasoning when it makes sense to, and we'll act consistently
whether the person involved is a first-time contributor or a maintainer.

## Attribution

Adapted from the [Contributor Covenant](https://www.contributor-covenant.org),
version 2.1. The enforcement tiers draw on Mozilla's code of conduct
enforcement ladder. For common questions, see the Contributor Covenant
[FAQ](https://www.contributor-covenant.org/faq).
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -238,3 +238,14 @@ tycoon ask context --schema mart # all tables in a schema
tycoon ask context --rules-only # just RULES.md
tycoon ask context # list available tables
```

## Contributing

tycoon is open source and still early, which means feedback right now has an
outsized effect on where it goes. However you want to jump in:

- **Hit a bug or want a feature?** Open an [issue](https://github.com/Database-Tycoon/tycoon-cli/issues) — there's a short form for each.
- **Got a question, or want to show what you're building?** Start a [discussion](https://github.com/Database-Tycoon/tycoon-cli/discussions). Nothing's too small.
- **Want to work on the code?** [CONTRIBUTING.md](CONTRIBUTING.md) covers dev setup, what CI expects, and the repo conventions.

Everyone taking part is expected to follow our [Code of Conduct](CODE_OF_CONDUCT.md).
Loading