TESTING

CONTRIBUTING.md

@@ -1,52 +1,125 @@
-# Contributing
+# Contributing to Rauch Tech CLI
+
+Thank you for your interest in contributing to Rauch Tech! We welcome contributions from the community and are committed to making the process as smooth as possible.
 
 ## Code of Conduct
 
-All interactions in the **npm** organization on GitHub are considered to be covered by our standard [Code of Conduct](https://docs.npmjs.com/policies/conduct).
+All interactions in the Rauch Tech organization on GitHub are covered by our [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you agree to uphold this code. Please report unacceptable behavior to [conduct@rauchtech.example](mailto:conduct@rauchtech.example).
 
 ## Reporting Bugs
 
-When submitting a new bug report, please first [search](https://github.com/npm/cli/issues) for an existing or similar report & then use one of our existing [issue templates](https://github.com/npm/cli/issues/new/choose) if you believe you've come across a unique problem. Duplicate issues, or issues that don't use one of our templates may get closed without a response.
+When submitting a new bug report, please:
+
+1. First [search](https://github.com/Rauch-Tech/cli/issues) for an existing or similar report.
+2. Use one of our existing [issue templates](https://github.com/Rauch-Tech/cli/issues/new/choose) if you believe you've come across a unique problem.
+3. Include as much detail as possible:
+   - Steps to reproduce
+   - Expected behavior
+   - Actual behavior
+   - Environment details (OS, Node version, etc.)
+
+Duplicate issues or issues that don't use our templates may be closed without a response.
 
 ## Development
 
-**1. Clone this repository...**
+### Getting Started
+
+**1. Fork and clone this repository**
 
 ```bash
-git clone git@github.com:npm/cli.git npm
+git clone git@github.com:YOUR-USERNAME/cli.git rauch-cli
+cd rauch-cli
 ```
 
-**2. Navigate into project & install development-specific dependencies...**
+**2. Install dependencies**
 
 ```bash
-cd ./npm && node ./scripts/resetdeps.js
+npm ci
+node ./scripts/resetdeps.js
 ```
 
-**3. Write some code &/or add some tests...**
+**3. Create a feature branch**
 
 ```bash
-...
+git checkout -b feat/short-description
 ```
 
-**4. Run tests & ensure they pass...**
+**4. Write code and add tests**
+
+- Write tests for new functionality
+- Ensure existing tests still pass
+- Follow the existing code style
+
+**5. Run tests and ensure they pass**
+
+```bash
+npm test
+```
+
+**6. Lint your code**
+
+```bash
+npm run lint
+npm run lintfix  # to automatically fix issues
 ```
-node . run test
+
+**7. Commit your changes**
+
+Follow our commit message conventions (see below).
+
+**8. Push and open a Pull Request**
+
+```bash
+git push origin feat/short-description
 ```
 
-**5. Open a [Pull Request](https://github.com/npm/cli/pulls) for your work & become the newest contributor to `npm`! 🎉**
+Open a [Pull Request](https://github.com/Rauch-Tech/cli/pulls) against the `main` branch.
 
 ## Pull Request Conventions
 
-We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).  When opening a pull request, please be sure that either the pull request title, or each commit in the pull request, has one of the following prefixes:
+We use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). When opening a pull request, please ensure that either the pull request title or each commit in the pull request has one of the following prefixes:
 
- - `feat`: For when introducing a new feature.  The result will be a new semver minor version of the package when it is next published.
- - `fix`: For bug fixes. The result will be a new semver patch version of the package when it is next published.
- - `docs`: For documentation updates.  The result will be a new semver patch version of the package when it is next published.
- - `chore`: For changes that do not affect the published module.  Often these are changes to tests.  The result will be *no* change to the version of the package when it is next published (as the commit does not affect the published version).
+- `feat`: Introduces a new feature (semver MINOR)
+- `fix`: Fixes a bug (semver PATCH)
+- `docs`: Documentation updates only (semver PATCH)
+- `chore`: Changes that don't affect the published module (no version change)
+- `refactor`: Code refactoring without changing functionality
+- `test`: Adding or updating tests
+- `perf`: Performance improvements
+- `ci`: Changes to CI/CD configuration
+
+### Pull Request Guidelines
+
+- Keep PRs focused and small where possible
+- Describe the rationale for your changes
+- Document any upgrade or migration impacts
+- Link related issues
+- Ensure all tests pass
+- Update documentation as needed
 
 ## Test Coverage
 
-We use [`tap`](https://node-tap.org/) for testing & expect that every new feature or bug fix comes with corresponding tests that validate the solutions. Tap also reports on code coverage and it will fail if that drops below 100%.
+We use [`tap`](https://node-tap.org/) for testing and expect that every new feature or bug fix comes with corresponding tests. We maintain 100% code coverage, and the build will fail if coverage drops below this threshold.
+
+## Code Style
+
+- Follow the existing code style in the project
+- Use ESLint to check your code: `npm run lint`
+- Fix linting issues automatically when possible: `npm run lintfix`
+
+## Documentation
+
+- Update relevant documentation when making changes
+- Keep comments clear and concise
+- Document public APIs and complex logic
+
+## Questions?
+
+If you have questions about contributing, feel free to:
+- Open a discussion in the repository
+- Contact the engineering team at [engineering@rauchtech.example](mailto:engineering@rauchtech.example)
+
+Thank you for contributing to Rauch Tech! 🎉
 
 To run your repository's version of the npm cli on your local machine use the following commands:
 

README.md

@@ -1,53 +1,155 @@
-# npm - a JavaScript package manager
+# Rauch Tech
+
+> Building dependable, human-centered technology for a safer digital world.
+
+Rauch Tech is a technology company focused on secure, reliable, and user-first software solutions. We design and build products and services that help organizations modernize infrastructure, protect critical assets, and deliver delightful user experiences.
+
+---
+
+## Contents
+
+- [About](#about)
+- [Mission & Values](#mission--values)
+- [What we do](#what-we-do)
+- [Products & Services](#products--services)
+- [Core Technologies](#core-technologies)
+- [Getting Started (Developers)](#getting-started-developers)
+- [Deployment & Operations](#deployment--operations)
+- [Contributing](#contributing)
+- [Code of Conduct](#code-of-conduct)
+- [Security](#security)
+- [Support & Contact](#support--contact)
+- [License](#license)
+- [Acknowledgements](#acknowledgements)
+
+---
+
+## About
+
+Rauch Tech partners with enterprises and startups to create secure, scalable, and maintainable software. Our team combines domain expertise in cloud-native architecture, security engineering, and UX design to deliver systems that perform in production and are easy to operate.
+
+## Mission & Values
+
+- **Mission**: Enable organizations to harness technology securely and responsibly.
+- **Values**:
+  - Security by design
+  - Reliability and observability
+  - Empathy for users and operators
+  - Simplicity over complexity
+  - Continuous learning and improvement
+
+## What we do
+
+We deliver end-to-end solutions for:
+- Secure cloud migrations and platform engineering
+- Application development (web, mobile, backend APIs)
+- Security assessments, threat modeling, and remediation
+- Observability, SRE practices, and incident response
+- Custom integrations and automation
+
+## Products & Services
+
+Examples of offerings:
+- **Rauch Platform** — opinionated Kubernetes + GitOps platform for teams
+- **Rauch Shield** — managed security assessments and remediation plans
+- **Rauch Insights** — observability and monitoring dashboards tailored to application SLIs
+- **Professional services**: architecture reviews, implementation sprints, staff augmentation
+
+## Core Technologies
+
+Typical stacks we use:
+- **Cloud**: AWS, GCP, Azure
+- **Orchestration**: Kubernetes, Helm, Kustomize
+- **CI/CD & GitOps**: GitHub Actions, Argo CD, Flux
+- **Backend**: Go, Node.js, Python
+- **Frontend**: React, TypeScript
+- **Datastores**: PostgreSQL, Redis, S3
+- **Observability**: Prometheus, Grafana, OpenTelemetry, Loki
+- **Security**: OAuth2/OpenID Connect, Vault, static analysis tools
+
+## Getting Started (Developers)
 
 ### Requirements
 
-You should be running a currently supported version of [Node.js](https://nodejs.org/en/download/) to run **`npm`**.  For a list of which versions of Node.js are currently supported, please see the [Node.js releases](https://nodejs.org/en/about/previous-releases) page.
+You should be running a currently supported version of [Node.js](https://nodejs.org/en/download/) to run this CLI. For a list of which versions of Node.js are currently supported, please see the [Node.js releases](https://nodejs.org/en/about/previous-releases) page.
 
 ### Installation
 
-**`npm`** comes bundled with [**`node`**](https://nodejs.org/), & most third-party distributions, by default. Officially supported downloads/distributions can be found at: [nodejs.org/en/download](https://nodejs.org/en/download)
+1. Clone the repository
+   ```bash
+   git clone https://github.com/Rauch-Tech/cli.git
+   cd cli
+   ```
+
+2. Install dependencies
+   ```bash
+   npm ci
+   ```
+
+3. Local dev environment
+   - Create a `.env` from `.env.example` and provide required secrets/config (if applicable).
+   - Start any required services via Docker Compose:
+     ```bash
+     docker compose up -d
+     ```
+
+4. Run tests
+   ```bash
+   npm test
+   ```
+
+5. Lint & format
+   ```bash
+   npm run lint
+   npm run lintfix
+   ```
+
+## Deployment & Operations
+
+- We use GitOps for production deployments. Changes merged to `main`/`production` branch are promoted automatically via Argo CD/Flux.
+- Use CI pipelines (GitHub Actions) for build, test, and image publishing.
+- For infrastructure, Terraform (or similar IaC) is used with a remote state backend.
+- Monitoring and alerts are configured in Grafana/Alertmanager; on-call rotations use PagerDuty/Slack.
+
+## Contributing
 
-#### Direct Download
+We welcome contributions. Please follow these steps:
 
-You can download & install **`npm`** directly from [**npmjs**.com](https://npmjs.com/) using our custom `install.sh` script:
+1. Fork the repository.
+2. Create a feature branch: `git checkout -b feat/short-description`.
+3. Commit changes with clear messages.
+4. Push to your fork and open a Pull Request against `main`.
+5. Ensure tests pass and add changelog/notes where relevant.
 
-```bash
-curl -qL https://www.npmjs.com/install.sh | sh
-```
+Guidelines:
+- Write tests for new functionality.
+- Keep PRs focused and small where possible.
+- Describe rationale and any upgrade/migration impacts.
 
-#### Node Version Managers
+See [CONTRIBUTING.md](CONTRIBUTING.md) for more details.
 
-If you're looking to manage multiple versions of **`Node.js`** &/or **`npm`**, consider using a [node version manager](https://github.com/search?q=node+version+manager+archived%3Afalse&type=repositories&ref=advsearch)
+## Code of Conduct
 
-### Usage
+We are committed to an inclusive, harassment-free community. By participating, you agree to follow our Code of Conduct. See [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) for details.
 
-```bash
-npm <command>
-```
+## Security
 
-### Links & Resources
+If you discover a security issue, please report it privately to [security@rauchtech.example](mailto:security@rauchtech.example). Do not disclose publicly until a fix or coordinated disclosure is agreed.
 
-* [**Documentation**](https://docs.npmjs.com/) - Official docs & how-tos for all things **npm**
-    * Note: you can also search docs locally with `npm help-search <query>`
-* [**Bug Tracker**](https://github.com/npm/cli/issues) - Search or submit bugs against the CLI
-* [**Community Feedback and Discussions**](https://github.com/orgs/community/discussions/categories/npm) - Contribute ideas & discussion around the npm registry, website & CLI
-* [**RFCs**](https://github.com/npm/rfcs) - Contribute ideas & specifications for the API/design of the npm CLI
-* [**Service Status**](https://status.npmjs.org/) - Monitor the current status & see incident reports for the website & registry
-* [**Project Status**](https://npm.github.io/statusboard/) - See the health of all our maintained OSS projects in one view
-* [**Support**](https://www.npmjs.com/support) - Experiencing problems with the **npm** [website](https://npmjs.com) or [registry](https://registry.npmjs.org)? [File a ticket](https://www.npmjs.com/support)
+See [SECURITY.md](SECURITY.md) for more information on our security reporting process.
 
-### Acknowledgments
+## Support & Contact
 
-* `npm` is configured to use the **npm Public Registry** at [https://registry.npmjs.org](https://registry.npmjs.org) by default; Usage of this registry is subject to **Terms of Use** available at [https://npmjs.com/policies/terms](https://npmjs.com/policies/terms)
-* You can configure `npm` to use any other compatible registry you prefer. You can read more about [configuring third-party registries](https://docs.npmjs.com/cli/v7/using-npm/registry)
+For general inquiries or sales:
+- Email: [hello@rauchtech.example](mailto:hello@rauchtech.example)
+- Website: https://rauchtech.example
 
-### FAQ on Branding
+For developer support, open issues in the relevant repository or contact the engineering lead.
 
-#### Is it "npm" or "NPM" or "Npm"?
+## License
 
-**`npm`** should never be capitalized unless it is being displayed in a location that is customarily all-capitals (ex. titles on `man` pages).
+This repository is licensed under the Artistic-2.0 License. See [LICENSE](LICENSE) for details.
 
-#### Is "npm" an acronym for "Node Package Manager"?
+## Acknowledgements
 
-Contrary to popular belief, **`npm`** **is not** in fact an acronym for "Node Package Manager"; It is a recursive bacronymic abbreviation for **"npm is not an acronym"** (if the project was named "ninaa", then it would be an acronym). The precursor to **`npm`** was actually a bash utility named **"pm"**, which was the shortform name of **"pkgmakeinst"** - a bash function that installed various things on various platforms. If **`npm`** were to ever have been considered an acronym, it would be as "node pm" or, potentially "new pm".
+Thanks to our contributors, community partners, and open source projects that make our work possible.