Update the Readme

CODE_OF_CONDUCT.md

@@ -55,7 +55,7 @@ representative at an online or offline event.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behaviour may be
-reported to the community leaders responsible for enforcement at <engineering@tower.dev>.
+reported to the community leaders responsible for enforcement at <hello@tower.dev>.
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the
@@ -113,3 +113,7 @@ This Code of Conduct is adapted from the [Contributor Covenant](https://contribu
 [1.4](https://www.contributor-covenant.org/version/1/4/code-of-conduct/code_of_conduct.md) and
 [2.0](https://www.contributor-covenant.org/version/2/0/code_of_conduct/code_of_conduct.md),
 and was generated by [contributing.md](https://contributing.md/generator).
+
+---
+
+See also: [CONTRIBUTING.md](CONTRIBUTING.md) · [DEVELOPMENT.md](DEVELOPMENT.md) · [README.md](README.md)

CONTRIBUTING.md

@@ -1,164 +1,72 @@
-<!-- omit in toc -->
 # Contributing to tower-cli
 
-First off, thanks for taking the time to contribute! ❤️
+Thanks for taking the time to contribute!
 
-All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉
-
-> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
-> - Star the project
-> - Tweet about it
-> - Refer this project in your project's readme
-> - Mention the project at local meetups and tell your friends/colleagues
-
-<!-- omit in toc -->
-## Table of Contents
-
-- [Code of Conduct](#code-of-conduct)
-- [I Have a Question](#i-have-a-question)
-  - [I Want To Contribute](#i-want-to-contribute)
-  - [Reporting Bugs](#reporting-bugs)
-  - [Suggesting Enhancements](#suggesting-enhancements)
-  - [Your First Code Contribution](#your-first-code-contribution)
-  - [Improving The Documentation](#improving-the-documentation)
-- [Styleguides](#styleguides)
-  - [Commit Messages](#commit-messages)
-- [Join The Project Team](#join-the-project-team)
+All types of contributions are encouraged and valued. Please read the relevant section before making your contribution.
 
+**Related documentation:**
+- [README.md](README.md) — Quick start
+- [DEVELOPMENT.md](DEVELOPMENT.md) — Development setup, running tests
+- [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) — Community guidelines
+- [INSTALL-AND-REFERENCE.md](INSTALL-AND-REFERENCE.md) — Advanced installation options
 
 ## Code of Conduct
 
-This project and everyone participating in it is governed by the
-[tower-cli Code of Conduct](https://github.com/tower/tower-cli/blob/main/CODE_OF_CONDUCT.md).
-By participating, you are expected to uphold this code. Please report unacceptable behavior
-to <engineering@tower.dev>.
-
+This project is governed by our [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Report unacceptable behavior to <hello@tower.dev>.
 
 ## I Have a Question
 
-> If you want to ask a question, we assume that you have read the available [Documentation](https://docs.tower.dev).
-
-Before you ask a question, it is best to search for existing [Issues](https://github.com/tower/tower-cli/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
-
-If you then still feel the need to ask a question and need clarification, we recommend the following:
+Before asking, please check the [documentation](https://docs.tower.dev) and search existing [issues](https://github.com/tower/tower-cli/issues).
 
-- Open an [Issue](https://github.com/tower/tower-cli/issues/new).
-- Provide as much context as you can about what you're running into.
-- Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.
-
-We will then take care of the issue as soon as possible.
-
-<!--
-You might want to create a separate issue tag for questions and include it in this description. People should then tag their issues accordingly.
-
-Depending on how large the project is, you may want to outsource the questioning, e.g. to Stack Overflow or Gitter. You may add additional contact and information possibilities:
-- IRC
-- Slack
-- Gitter
-- Stack Overflow tag
-- Blog
-- FAQ
-- Roadmap
-- E-Mail List
-- Forum
--->
+If you still need help:
+- Open an [issue](https://github.com/tower/tower-cli/issues/new)
+- Provide as much context as you can
+- Include relevant version info (Python, OS, tower-cli version)
 
 ## I Want To Contribute
 
-> ### Legal Notice <!-- omit in toc -->
-> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project licence.
+> **Legal Notice:** When contributing, you must agree that you have authored 100% of the content, have the necessary rights, and that it may be provided under the project license.
 
 ### Reporting Bugs
 
-<!-- omit in toc -->
-#### Before Submitting a Bug Report
-
-A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
-
-- Make sure that you are using the latest version.
-- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://docs.tower.dev). If you are looking for support, you might want to check [this section](#i-have-a-question)).
-- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/tower/tower-cli/issues?q=label%3Abug).
-- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
-- Collect information about the bug:
-  - Stack trace (Traceback)
-  - OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
-  - Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
-  - Possibly your input and the output
-  - Can you reliably reproduce the issue? And can you also reproduce it with older versions?
-
-<!-- omit in toc -->
-#### How Do I Submit a Good Bug Report?
+#### Before Submitting
 
-> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to <security@tower.dev>.
-<!-- You may add a PGP key to allow the messages to be sent encrypted as well. -->
+- Make sure you're using the latest version
+- Verify it's a bug and not a configuration issue (check the [docs](https://docs.tower.dev))
+- Search the [bug tracker](https://github.com/tower/tower-cli/issues?q=label%3Abug) for existing reports
+- Collect: stack trace, OS/platform, relevant versions, reproduction steps
 
-We use GitHub issues to track bugs and errors. If you run into an issue with the project:
+#### Submitting a Bug Report
 
-- Open an [Issue](https://github.com/tower/tower-cli/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
-- Explain the behavior you would expect and the actual behavior.
-- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
-- Provide the information you collected in the previous section.
+> **Security issues:** Never report security vulnerabilities publicly. Email <hello@tower.dev> instead.
 
-Once it's filed:
-
-- The project team will label the issue accordingly.
-- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced.
-- If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be [implemented by someone](#your-first-code-contribution).
-
-<!-- You might want to create an issue template for bugs and errors that can be used as a guide and that defines the structure of the information to be included. If you do so, reference it here in the description. -->
+Open an [issue](https://github.com/tower/tower-cli/issues/new) with:
+- Expected vs actual behavior
+- Reproduction steps
+- Environment details
 
+The team will label and triage accordingly.
 
 ### Suggesting Enhancements
 
-This section guides you through submitting an enhancement suggestion for tower-cli, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
-
-<!-- omit in toc -->
-#### Before Submitting an Enhancement
+#### Before Submitting
 
-- Make sure that you are using the latest version.
-- Read the [documentation](https://docs.tower.dev) carefully and find out if the functionality is already covered, maybe by an individual configuration.
-- Perform a [search](https://github.com/tower/tower-cli/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
-- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
+- Check if functionality already exists in the [docs](https://docs.tower.dev)
+- Search [existing issues](https://github.com/tower/tower-cli/issues) first
+- Consider if the feature benefits most users
 
-<!-- omit in toc -->
-#### How Do I Submit a Good Enhancement Suggestion?
+#### Submitting an Enhancement
 
-Enhancement suggestions are tracked as [GitHub issues](https://github.com/tower/tower-cli/issues).
-
-- Use a **clear and descriptive title** for the issue to identify the suggestion.
-- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
-- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
-- You may want to **include screenshots or screen recordings** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [LICEcap](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and the built-in [screen recorder in GNOME](https://help.gnome.org/users/gnome-help/stable/screen-shot-record.html.en) or [SimpleScreenRecorder](https://github.com/MaartenBaert/ssr) on Linux. <!-- this should only be included if the project has a GUI -->
-- **Explain why this enhancement would be useful** to most tower-cli users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
-
-<!-- You might want to create an issue template for enhancement suggestions that can be used as a guide and that defines the structure of the information to be included. If you do so, reference it here in the description. -->
+Open an [issue](https://github.com/tower/tower-cli/issues) with:
+- Clear, descriptive title
+- Step-by-step description of the enhancement
+- Current behavior vs expected behavior
+- Why this would be useful
 
 ### Your First Code Contribution
-<!-- TODO
-include Setup of env, IDE and typical getting started instructions?
-
--->
-
-### Improving The Documentation
-<!-- TODO
-Updating, improving and correcting the documentation
-
--->
-
-
-
-## Styleguides
-### Commit Messages
-<!-- TODO
-
--->
 
-## Join The Project Team
-<!-- TODO -->
+See [DEVELOPMENT.md](DEVELOPMENT.md) for environment setup, running tests, and development workflow.
 
-<!-- omit in toc -->
-## Attribution
-This guide is based on the [contributing.md](https://contributing.md/generator)!
+---
 
-## License for Contributions
-By submitting a pull request, issue, or any other contribution to this repository, you agree that your contributions will be licensed under the same license that governs this project (as found in the [LICENSE](./LICENSE) file in the repository root). This means your contributions will be included under the project’s existing open source terms and conditions.
+This guide is based on [contributing.md](https://contributing.md/generator).

DEVELOPMENT.md

@@ -0,0 +1,81 @@
+# Tower CLI and SDK — Development Guide
+
+Development setup and tooling for contributors.
+
+For contribution guidelines (reporting bugs, suggesting features, code of conduct), see [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## Runtime architecture (Rust + Python)
+
+The [tower-runtime](crates/tower-runtime) crate is the Rust runtime used to execute Tower apps. The main crate defines the interfaces; the `local` package implements running Tower packages locally.
+
+See the [tower-package](crates/tower-package) crate for how Tower packages are built and run.
+
+## Development setup
+
+Make sure you have [`uv`](https://github.com/astral-sh/uv) installed.
+
+To interactively test your changes, start a REPL with the project installed in development mode:
+
+```bash
+uv run python
+```
+
+```python
+>>> import tower
+>>> table = tower.tables("my_table").load()
+```
+
+## Running the CLI locally
+
+```bash
+uv run tower --help
+```
+
+## Running tests
+
+Copy `pytest.ini.template` to `pytest.ini`:
+
+```bash
+cp pytest.ini.template pytest.ini
+```
+
+Set the required environment variables (e.g. `TOWER_INFERENCE_ROUTER_API_KEY`) to your own or test values.
+
+Then install dependencies and run the tests:
+
+```bash
+uv sync --locked --all-extras --dev
+uv run pytest tests
+```
+
+## Development flow
+
+Typical development loop:
+
+1. Make changes
+2. Run `uv run pytest tests`
+3. Run `uv run tower --help` or other CLI commands to verify behavior
+
+## OpenAPI SDK
+
+If you need to get the latest OpenAPI SDK, you can run:
+
+```bash
+./scripts/generate-python-api-client.sh
+```
+
+## Code Formatting
+
+We use Black for Python code formatting. The pre-commit hooks will automatically format your code, but you can also run it manually:
+
+```bash
+# Format all Python files in the project
+uv run --group dev black .
+
+# Check formatting without making changes
+uv run --group dev black --check .
+```
+
+## Code of conduct
+
+Contributions must follow our [Code of Conduct](CODE_OF_CONDUCT.md).