Improve developer documentation
Mantenedores costumam responder em até 1 dia
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 3/5
- Tempo estimado
- 1-2 dias
- Facilidade para iniciantes
- 55/100
- Tipo de issue
- Documentação
- Clareza
- Razoavelmente clara
- Status de atividade
- Estagnada
- Stack de tecnologia
- python
- Domínio
- documentation
Direção de pesquisa
Start with CONTRIBUTING.md at the repository root and follow the four requested changes: put the Python installation section first, link to the CI build configuration, add a short overview of repo structure and test strategy, and note when a CHANGELOG entry is needed. The payload does not name the CI config file or the test layout, so find those yourself. Done means the document reads in order for a new contributor, and someone has followed it on a clean machine, including the Python version issue on macOS 11 that the issue reports.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
This could be as simple as updating the CONTRIBUTING.md to be more accessible:
- start with recommended system installation of python(s) first before other sections
- link to the configuration of the commands run on CI build + expectations on what is done locally vs. at pr-time
- high-level overview of repo structure and test strategy (old strategy vs. new, where to add tests and when)
- the need for a CHANGELOG message
Also I'd recommend trying a fresh setup by literally following the instructions, it's quite sparse, and as I said, I cannot get python <= 3.6 functioning on my machine, so others running a similar later version of macOS 11 are likely to experience the same issue.
- Linguagem predominante
- Python
- Estrelas
- 214
- Forks
- 68
- Merge médio
- 51min
- PRs com merge (30d)
- 6
Preparar o ambiente
- Sem Dockerfile nem arquivo Docker Compose
- Sem modelo de pull request
- Ler o guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de Backblaze/b2-sdk-python
-
Download and copy sync actions print remote file names without escape_control_charsTalvez já em andamento @dreyfus92 assumiu há 15 dias. Aberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
Backblaze/b2-sdk-python#631 ·
Mantenedores costumam responder em até 1 dia
-
SqliteAccountInfo profile name validation uses "re.match", so only the first character is checkedTalvez já em andamento @nazarli-shabnam assumiu há 9 dias. Aberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 75/100
Backblaze/b2-sdk-python#629 ·
Mantenedores costumam responder em até 1 dia
-
Adopt the AI-native SDLC and repository policiesTalvez já em andamento @goanpeca assumiu há 18 dias. Abertaenhancement
Dificuldade 5/5 Mais de uma semana Facilidade para iniciantes 20/100
Backblaze/b2-sdk-python#634 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 50/100
Backblaze/b2-sdk-python#630 ·
Mantenedores costumam responder em até 1 dia
-
ci: cli-compat fails — 4 sse/sync integration tests broken in B2_Command_Line_Tool (all environments)Talvez livre de novo @ffumero2003 assumiu há 37 dias e não há nenhum pull request aberto. Abertabug testing
Backblaze/b2-sdk-python#627 · 2 comentários · 1 responsável ·
Mantenedores costumam responder em até 1 dia
Todas as issues de Backblaze/b2-sdk-python
Issues semelhantes
-
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 72/100
btclib-org/btclib-node#2505 · 1 comentário ·
Mantenedores costumam responder em até 1 dia
-
bug
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
open-webui/open-webui#34462 · 1 comentário ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
gorakhargosh/watchdog#1462 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 85/100
openwisp/openwisp-monitoring#889 ·
Mantenedores costumam responder em até 2 dias
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
IETF-Hackathon/pqc-certificates#351 ·
Mantenedores costumam responder em até 2 dias