Files

CI / lint-and-test (push) Successful in 16s

Details

docs: add contributing guidelines and update README for environment variables

- Created a new `CONTRIBUTING.md` file outlining development setup, testing, and commit message conventions.
- Updated `README.md` to clarify environment variable usage, including new variables for HTTP port, CORS origins, and duty display timezone.
- Enhanced documentation for bot commands and API endpoints to improve user understanding and onboarding.
- Added example configurations in `.env.example` for better clarity on optional settings.

2026-02-18 17:00:42 +03:00

1.1 KiB

Raw Blame History

Contributing to Duty Teller

Development setup

Clone the repository

git clone <repository-url>
cd duty-teller

Create a virtual environment

python -m venv venv
source venv/bin/activate   # Linux/macOS
# or: venv\Scripts\activate  # Windows

Install dependencies

pip install -r requirements.txt
pip install -r requirements-dev.txt

Configure
```
cp .env.example .env
```
Set BOT_TOKEN and any other variables as needed (see README).

Running tests and linters

Tests (from repository root; package is duty_teller, no src/):
```
pytest
```
Use PYTHONPATH=. if imports fail.
Lint (ruff):
```
ruff check duty_teller tests
```
Security (bandit):
```
bandit -r duty_teller -ll
```

Commit messages

Use Conventional Commits, e.g.:

feat: add /pin_duty command
fix: correct timezone in pinned message
docs: update README env section

Submit changes via pull requests (Gitea Flow); reviews consider functionality, code quality, and security.

1.1 KiB Raw Blame History

Contributing to Duty Teller

Development setup

Running tests and linters

Commit messages

1.1 KiB

Raw Blame History