CONTRIBUTING.md

Contributing

Development Setup

Prerequisites:

• Node.js 20 or higher
• npm

1. Clone the repository

git clone https://github.com/tomquist/hame-relay.git
cd hame-relay

2. Install dependencies

npm install

3. Build

npm run build

4. Run

npm start

For development with automatic reloading:

npm run dev

Testing

Run the test suite:

npm test

Run linting:

npm run lint

Fix linting issues automatically:

npm run lint:fix

Pull Requests

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Please make sure your PR:

• Has a clear description of the changes
• Follows the existing code style
• Includes relevant updates to documentation
• Passes all tests (npm test)
• Passes linting checks (npm run lint)