Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Add architecture.md

Open
#12 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
django, github, python
Domain
backend, devops, documentation

Research direction

Start by reading the repository's Django, bot, and worker setup, then inspect the existing local-run, deployment, GitHub integration, and test entry points. Done means adding architecture.md with explanations for each listed workflow, guidance for tests and bot commands, and diagrams covering the components and deployment.

Written by the indexing model from the issue text.

Description

There are a couple of things to explain how the:

  • django, bot and worker are set up
  • how to run it locally
  • how the deployment works
  • how the github integration is set up (because it involves extra API calls)
  • how and where to add tests
  • how to add a bot command
  • diagrams of all the components
  • diagram of the deployment
Dominant language
Python
Stars
5
Forks
0
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from EuroPython/internal-bot

All issues in EuroPython/internal-bot

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.