python / python/python-docs-pt-br

Melhorar o README

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

Nobody has claimed this yet.

enhancement help wanted
Dominant language
Python
Stars
164
Forks
42
Avg merge
14h 32m
Merged PRs (30d)
4

Description

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?

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.

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.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.