Skip to content

Development Guide

UpperCenter edited this page May 30, 2025 · 1 revision

Development Guide

This page provides guidance for developers who wish to contribute to NHK-TS.

Setting Up the Development Environment

  1. Clone the repository:
    git clone https://github.com/UpperCenter/nhk-ts.git
    cd nhk-ts
  2. Install dependencies:
    npm install
  3. Build the project:
    npm run build
  4. Lint and format code:
    npm run lint
    npm run format

Contributing

  • Fork the repository and create a feature branch
  • Follow the code style and linting rules
  • Submit a pull request with a clear description

Release Process

  • Versioning follows semantic versioning
  • Releases are managed via GitHub Actions (see .github/workflows/release.yml)
  • Docker images are built and published automatically on new releases

For questions or to discuss features, please open an issue on GitHub.

Clone this wiki locally