Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
56 lines (37 loc) · 2.29 KB

CONTRIBUTING.md

File metadata and controls

56 lines (37 loc) · 2.29 KB
Raw

Contributing to txio-telegram-bot

First off, thank you for considering contributing! It's people like you that help keep the Txio team's GitHub activity visible and actionable in one place.

How Can I Contribute?

Reporting Bugs

Before creating a bug report, please check the existing issues — you might find you don't need to open a new one. When you do open one, please include:

  • A clear and descriptive title
  • The exact steps that reproduce the problem
  • What you expected to happen vs. what actually happened
  • Relevant logs (with any secrets/tokens redacted)

Suggesting Enhancements

Enhancement suggestions are tracked as GitHub issues. Please include:

  • A clear and descriptive title
  • A step-by-step description of the suggested enhancement
  • Why it would be useful to the team running this bot

Pull Requests

  • Do not include issue numbers in the PR title.
  • Before merging, automated checks must pass (build/typecheck; tests once a suite exists).
  • End all files with a newline.
  • Keep PRs scoped to a single concern — this makes review faster and keeps git blame useful.

Development Setup

npm install
npm run dev     # local development, runs src/index.ts via tsx with live reload
npm run build && npm start   # production build

You'll need a .env file (copy .env.example) with a Telegram bot token, chat id, and a GitHub webhook secret — see the README for the full setup walkthrough.

There is no automated test suite yet; if you're adding a webhook handler or formatter, consider adding unit tests for it as part of your PR.

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

Code Style

  • TypeScript, ES modules ("type": "module" in package.json)
  • Follow the existing pattern in src/github/formatters.ts for new event formatters: an icon, a linked repo/issue/PR, and an escaped-HTML body
  • Keep webhook handlers in src/github/webhooks.ts thin — formatting logic belongs in formatters.ts, delivery logic belongs in src/telegram/client.ts