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

Melhorar o README

Open
#38 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
python

Research direction

Start by reviewing the repository's current README, which currently contains only the CLA and CI badge. Clarify the desired scope with maintainers, then document how to compile the translated documentation and add a Telegram group link if agreed; the README should provide useful guidance for current and new users.

Written by the indexing model from the issue text.

Description

enhancement help wanted

Atualmente o README deste repositório contém apenas o CLA e badge de CI.

Penso que seria interessante termos mais informações nele que sejam úteis tanto para usuários atuais quanto novatos/passageiros. Por exemplo, poderíamos ter instruções sobre como compilar a documentação traduzida ou um link para o grupo do Telegram para quem quiser possa nos contatar.

Ideias, sugestões?

Dominant language
Python
Stars
164
Forks
42
Avg merge
12h 39m
Merged PRs (30d)
4

Getting set up

We have not checked this project's setup files yet. Start from its README, and see our first-contribution guide for the general steps.

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 python/python-docs-pt-br

All issues in python/python-docs-pt-br

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.