Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
name: Bug report
about: Report a reproducible bug in AiogramShopBot
title: "[Bug] "
labels: bug
assignees: ""
---

## Summary

Describe the bug clearly.

## Steps to Reproduce

1.
2.
3.

## Expected Behavior

What should happen?

## Actual Behavior

What happened instead?

## Environment

- Python version:
- Runtime mode:
- Database:
- Redis:

## Logs / Screenshots

Add any useful logs, traces, or screenshots.
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: true
contact_links:
- name: Security report
url: https://t.me/ilyarolf_dev
about: Please report security issues privately.
- name: Documentation
url: https://github.com/ilyarolf/AiogramShopBot/blob/master/docs.md
about: Check the docs before opening a support request.
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Feature request
about: Suggest an improvement for AiogramShopBot
title: "[Feature] "
labels: enhancement
assignees: ""
---

## Problem

What problem are you trying to solve?

## Proposed Solution

Describe the change you want.

## Alternatives

Describe any alternative solutions or workarounds.

## Additional Context

Add examples, screenshots, or references if helpful.
18 changes: 18 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
## Summary

Describe what changed and why.

## Changes

-

## Verification

- [ ] I ran relevant tests
- [ ] I updated docs if needed
- [ ] I kept the change focused
- [ ] I checked affected bot/admin/payment flows

## Notes

Anything reviewers should pay special attention to:
30 changes: 30 additions & 0 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Tests

on:
push:
branches:
- master
- develop
- codex/**
pull_request:

jobs:
test:
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v4

- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: "3.12"

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt

- name: Run tests
run: pytest
33 changes: 33 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Code of Conduct

## Our Pledge

We want AiogramShopBot to be a welcoming, respectful, and useful open source project for everyone.
Contributors, maintainers, and community members are expected to act professionally and constructively in all project spaces.

## Expected Behavior

- Be respectful and patient.
- Assume good intent and communicate clearly.
- Focus on technical feedback, not personal attacks.
- Welcome different levels of experience.
- Help keep discussions actionable and on topic.

## Unacceptable Behavior

- Harassment, intimidation, or discrimination of any kind.
- Insults, trolling, or sustained hostile behavior.
- Publishing private information without permission.
- Spam, deliberate disruption, or bad-faith reporting.

## Enforcement

Project maintainers may remove, edit, or reject comments, issues, pull requests, and other contributions that violate this Code of Conduct.

## Reporting

If you experience or witness unacceptable behavior, report it privately:

- Telegram: [@ilyarolf_dev](https://t.me/ilyarolf_dev)

All reports will be reviewed reasonably and handled with discretion.
51 changes: 51 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Contributing to AiogramShopBot

Thanks for your interest in improving AiogramShopBot.

## Before You Start

- Read [README.md](readme.md) and [docs.md](docs.md).
- Open an issue first for large changes, architectural changes, or behavior changes.
- Keep changes incremental and easy to review.

## Development Setup

```bash
git clone https://github.com/ilyarolf/AiogramShopBot.git
cd AiogramShopBot
pip install -r requirements.txt
python run.py
```

You will also need PostgreSQL, Redis, and environment variables configured.

## Contribution Guidelines

- Preserve existing architecture and naming style.
- Avoid broad refactors unless they are necessary.
- Keep payment, balance, invoice, callback, and order logic conservative.
- Update JSON localization files for user-facing text changes.
- Add or update tests for changed behavior.
- Keep pull requests focused.

## Pull Request Checklist

- The change is scoped and reviewable.
- Tests were added or updated when appropriate.
- Documentation was updated if behavior changed.
- No unrelated cleanup was bundled in.
- Sensitive financial behavior was not changed silently.

## Areas That Need Extra Care

- Payments and callbacks
- Balance updates
- Multibot behavior
- Database queries and migrations
- Localization keys and admin/user flows

## Questions

For discussion or coordination:

- Telegram: [@ilyarolf_dev](https://t.me/ilyarolf_dev)
34 changes: 34 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Security Policy

## Supported Versions

Security issues should be reported for the latest maintained branch and current production-ready code.

## Reporting a Vulnerability

Please do **not** open public GitHub issues for security vulnerabilities.

Report vulnerabilities privately:

- Telegram: [@ilyarolf_dev](https://t.me/ilyarolf_dev)

When possible, include:

- affected area or feature
- steps to reproduce
- impact assessment
- logs, screenshots, or payload examples if safe to share

## Sensitive Areas

Please report issues responsibly if they affect:

- payment callbacks
- invoice creation
- wallet withdrawals
- admin authorization
- webhook validation
- referral abuse
- multibot token handling

We will review reports as quickly as possible and coordinate remediation privately where needed.
17 changes: 17 additions & 0 deletions SUPPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Support

## Documentation

- [README.md](readme.md)
- [docs.md](docs.md)

## Commercial and Maintainer Contact

- Telegram: [@ilyarolf_dev](https://t.me/ilyarolf_dev)

## Before Opening an Issue

- Check the documentation first.
- Confirm your environment variables are configured.
- Include logs, stack traces, and reproduction steps.
- For security issues, use [SECURITY.md](SECURITY.md) instead of a public issue.
Loading
Loading