# Contributing to XSim

Thanks for helping improve XSim.

## Getting Started

1. Install dependencies:

```bash
npm install
```

2. Link the CLI locally if you want to test it from your shell:

```bash
npm run link
```

3. Inspect the available commands:

```bash
xsim --help
```

## Development Notes

- Keep changes aligned with the existing CommonJS style.
- Prefer small, focused commits or patches when making behavior changes.
- Update the README whenever you change a command, flag, or config field.
- If you add or change profile behavior, make sure the examples in the README still match the generated output.

## Testing

There is no dedicated test suite in the repository yet.

Before opening a change, at minimum:

- run `npm run lint`
- manually exercise the relevant CLI command if your environment supports it
- check that any new docs accurately reflect the current behavior

## Documentation Style

When updating docs:

- use concrete command examples
- prefer absolute paths in examples where they help clarity
- describe default behavior explicitly
- call out any required external tools such as `xcodebuild`, `xcrun`, `axe`, `brew`, or `swift`

## Reporting Issues

When filing a bug report, include:

- your macOS version
- your Xcode version
- the exact `xsim` command you ran
- the full error output
- a minimal example of the relevant `config.yml` when possible

## License

By contributing, you agree that your contributions will be licensed under the MIT License.