seraph-agent/CONTRIBUTING.md

An extremely lightweight, SRE autonomous AI agent for seamless integration with common observability tasks.

# Contributing to Seraph

First off, thank you for considering contributing to Seraph! It's people like you that make open source such a great community.

We welcome any type of contribution, not just code. You can help with:
*   **Reporting a bug**
*   **Discussing the current state of the code**
*   **Submitting a fix**
*   **Proposing new features**
*   **Becoming a maintainer**

## Getting Started

### Reporting Bugs

If you find a bug, please open an issue on our [GitHub Issues](https://https://github.com/InventiveWork/seraph/issues) page. Please include as much detail as possible, including:
*   A clear and descriptive title.
*   A description of the problem.
*   Steps to reproduce the bug.
*   The version of Seraph you are using.

### Suggesting Enhancements

If you have an idea for a new feature or an enhancement to an existing one, please open an issue on our [GitHub Issues](https://https://github.com/InventiveWork/seraph/issues) page. This allows us to discuss the proposal and ensure it aligns with the project's goals.

### Setting Up Your Development Environment

1.  Fork the repository on GitHub.
2.  Clone your fork locally:
    ```bash
    git clone https://github.com/YOUR_USERNAME/seraph-agent.git
    ```
3.  Navigate to the project directory:
    ```bash
    cd seraph-agent
    ```
4.  Install the dependencies:
    ```bash
    npm install
    ```

### Running Tests

To ensure the stability of the codebase, please run the test suite before submitting a pull request.

```bash
npm test
```

## Pull Request Process

1.  Ensure any install or build dependencies are removed before the end of the layer when doing a build.
2.  Update the `README.md` with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations, and container parameters.
3.  Increase the version numbers in any examples and the `package.json` to the new version that this Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
4.  You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

## Code of Conduct

This project and everyone participating in it is governed by the [Seraph Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior.

## Questions?

If you have any questions, feel free to open an issue. We're here to help!