Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
76 lines (51 loc) · 1.6 KB

CONTRIBUTING.md

File metadata and controls

76 lines (51 loc) · 1.6 KB

Contributing to LoRaWAN CUPS Server

Thank you for your interest in contributing. This document explains how to get started, what to expect, and how to submit changes.

Getting Started

  1. Fork the repository on GitHub.
  2. Clone your fork: 
    git clone https://github.com/your-username/lorawan-cups-server.git
cd lorawan-cups-server
  3. Install dependencies: 
    npm install
  4. Copy .env.example to .env and fill in the required values.
  5. Create a feature branch: 
    git checkout -b feat/your-feature-name

Development

Run the server in development mode (live TypeScript execution):

npm run dev

Code Quality

This project uses ESLint and TypeScript strict mode. Pre-commit hooks (Husky + lint-staged) will block commits that fail linting or type checks.

Run checks manually at any time:

npm run eslint          # lint
npm run check-types     # type check
npm run lint-and-types  # both

Fix auto-fixable lint issues:

npm run eslint:fix

Please ensure all checks pass before opening a pull request.

Submitting Changes

  1. Commit your changes with a clear, descriptive message.
  2. Push your branch and open a pull request against main.
  3. Describe what the change does and why in the pull request description.
  4. A maintainer will review and provide feedback.

Reporting Issues

Open an issue on GitHub with a clear description of the problem, steps to reproduce, and any relevant logs or error messages.

Code of Conduct

Be respectful and constructive. We welcome contributions from everyone.